C#Code
C#Code
Public Member Functions | Protected Member Functions | Protected Attributes
TheForum.GameCode.SpecialEvents.BaseSpecialEvent Class Reference
Inheritance diagram for TheForum.GameCode.SpecialEvents.BaseSpecialEvent:
TheForum.GameCode.LifeChoice.BaseLifeChoiceEvent TheForum.GameCode.SpecialEvents.BaseTransitionSE TheForum.GameCode.SpecialEvents.ExitGameplaySE TheForum.GameCode.SpecialEvents.ExitTutorialSE TheForum.GameCode.SpecialEvents.JailItemSE TheForum.GameCode.SpecialEvents.PieceParticlesSE TheForum.GameCode.SpecialEvents.SpecialEventBandwagon TheForum.GameCode.SpecialEvents.SpecialEventBandwagon TheForum.GameCode.SpecialEvents.SpecialEventDied TheForum.GameCode.SpecialEvents.SpecialEventExpenses TheForum.GameCode.SpecialEvents.SpecialEventIgnoreBoardSelection TheForum.GameCode.SpecialEvents.SpecialEventJail TheForum.GameCode.SpecialEvents.SpecialEventLowContent TheForum.GameCode.SpecialEvents.SpecialEventLowContent TheForum.GameCode.SpecialEvents.SpecialEventPermaban TheForum.GameCode.SpecialEvents.SpecialEventPermaban TheForum.GameCode.SpecialEvents.SpecialEventPostMessage TheForum.GameCode.SpecialEvents.SpecialEventPostMessage TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage TheForum.GameCode.SpecialEvents.SpecialEventProbation TheForum.GameCode.SpecialEvents.SpecialEventProbation TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale TheForum.GameCode.SpecialEvents.SpecialEventUseFlag TheForum.GameCode.SpecialEvents.UnknownItemSE

List of all members.

Public Member Functions

 BaseSpecialEvent ()
 BaseSpecialEvent (string ID)
abstract void Update (int timePassed, Libraries.AssetManager assetM)
abstract void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
bool IsFinished ()
virtual void RunAsFinished ()
virtual void SetAsFinished ()
bool CheckForFlag (Libraries.StringType flag)
Libraries.StringType GetID ()
abstract Libraries.StringType GetEventType ()
void SetIgnoreIfPaused (bool ignore)
void SetIgnoreIfFrozen (bool ignore)
bool GetIgnoreIfPaused ()
bool GetIgnoreIfFrozen ()
void SetRunOnFinish (Libraries.CallbackDelegate delegateUse, Object objData)
 BaseSpecialEvent ()
 BaseSpecialEvent (string ID)
abstract void Update (int timePassed, Libraries.AssetManager assetM)
abstract void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
abstract bool IsFinished ()
bool CheckForFlag (Libraries.StringType flag)
Libraries.StringType GetID ()
abstract Libraries.StringType GetEventType ()

Protected Member Functions

void RunFinishedDelegate ()
int FindFlagInd (Libraries.StringType flag)
void RemoveFlag (Libraries.StringType flag)
void RemoveFlagOccurences (Libraries.StringType flag)
int FindFlagInd (Libraries.StringType flag)
void RemoveFlag (Libraries.StringType flag)
void RemoveFlagOccurences (Libraries.StringType flag)

Protected Attributes

Libraries.StringType m_ID
 ID that represents the event. This should be unique to the event or null. It has to be non-null if you want to be able to access it by ID.
List< Libraries.StringTypem_flags
 Flags that the event has. Flags can be checked by the game to cause events to happen/not happen.
bool m_ignoreIfPaused
 Value is true if the event should be ignored when the game is paused, false if not. If ignored then it shouldn't be told to update or render.
bool m_ignoreIfFrozen
 Value is true if the event should be ignored when the game is frozen, false if not. If ignored then it shouldn't be told to update or render.
bool m_allowUpdate
 Whether the event should update if it's update function is called. Value is true if it should, false if not.
Libraries.CallbackDelegate m_finishedDelegate
 Delegate to run when the special event is marked as finished.
Object m_finishedDelegateData
 Data to pass when calling the finished delegate.
bool m_isFinished
 Flag to represent if the special event is finished. Value should be true if it is, false if not.

Detailed Description

Base special event class. All special events should be derived from this. Special events are things that happen in the game, like the item effects themselves. Special events can put other services on hold or prevent them from occuring. This way special events can be sure that other things don't run and interupt them. Events can have flags added to them that are checked for by the game. The game can be coded to check for flags like preventing piece settling from occuring.


Constructor & Destructor Documentation

TheForum.GameCode.SpecialEvents.BaseSpecialEvent.BaseSpecialEvent ( )

Default constructor.

TheForum.GameCode.SpecialEvents.BaseSpecialEvent.BaseSpecialEvent ( string  ID)

Default constructor.

TheForum.GameCode.SpecialEvents.BaseSpecialEvent.BaseSpecialEvent ( )

Default constructor.

TheForum.GameCode.SpecialEvents.BaseSpecialEvent.BaseSpecialEvent ( string  ID)

Default constructor.


Member Function Documentation

bool TheForum.GameCode.SpecialEvents.BaseSpecialEvent.CheckForFlag ( Libraries.StringType  flag)

Check wether the event has the given flag.

flag - Flag to check for.

Return:
Value is true if the event ihas the flag, false if not.
bool TheForum.GameCode.SpecialEvents.BaseSpecialEvent.CheckForFlag ( Libraries.StringType  flag)

Check wether the event has the given flag.

Return:
Value is true if the event ihas the flag, false if not.

int TheForum.GameCode.SpecialEvents.BaseSpecialEvent.FindFlagInd ( Libraries.StringType  flag) [protected]

Find the first index of the given flag if it is stored.

flag - Flag to find.

Return:
Value is the index if found, -1 if not.
int TheForum.GameCode.SpecialEvents.BaseSpecialEvent.FindFlagInd ( Libraries.StringType  flag) [protected]

Find the first index of the given flag if it is stored.

flag - Flag to find.

Return:
Value is the index if found, -1 if not.
abstract Libraries.StringType TheForum.GameCode.SpecialEvents.BaseSpecialEvent.GetEventType ( ) [pure virtual]

Gets the type of the event.

Return:
Value is the ID that represents the event type.

Implemented in TheForum.GameCode.LifeChoice.GetCrookedAccountentLifeChoice, TheForum.GameCode.LifeChoice.GetJobLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetMarriedLifeChoiceEvent, TheForum.GameCode.LifeChoice.MarriedLifeChoiceEvent, TheForum.GameCode.SpecialEvents.BaseTransitionSE, TheForum.GameCode.SpecialEvents.ChangeMusicVolumeSE, TheForum.GameCode.SpecialEvents.ExitGameplaySE, TheForum.GameCode.SpecialEvents.ExitTutorialSE, TheForum.GameCode.SpecialEvents.JailItemSE, TheForum.GameCode.SpecialEvents.PieceCurtainTransitionSE, TheForum.GameCode.SpecialEvents.PieceParticlesSE, TheForum.GameCode.SpecialEvents.PieceScaleTransitionSE, TheForum.GameCode.SpecialEvents.PieceTransitionSE, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventDied, TheForum.GameCode.SpecialEvents.SpecialEventExpenses, TheForum.GameCode.SpecialEvents.SpecialEventIgnoreBoardSelection, TheForum.GameCode.SpecialEvents.SpecialEventJail, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale, TheForum.GameCode.SpecialEvents.SpecialEventUseFlag, TheForum.GameCode.SpecialEvents.StartCheatEventsSE, TheForum.GameCode.SpecialEvents.UnknownItemSE, TheForum.GameCode.SpecialEvents.WaitWhileUpdate, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, and TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.

abstract Libraries.StringType TheForum.GameCode.SpecialEvents.BaseSpecialEvent.GetEventType ( ) [pure virtual]

Gets the type of the event.

Implemented in TheForum.GameCode.LifeChoice.GetCrookedAccountentLifeChoice, TheForum.GameCode.LifeChoice.GetJobLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetMarriedLifeChoiceEvent, TheForum.GameCode.LifeChoice.MarriedLifeChoiceEvent, TheForum.GameCode.SpecialEvents.BaseTransitionSE, TheForum.GameCode.SpecialEvents.ChangeMusicVolumeSE, TheForum.GameCode.SpecialEvents.ExitGameplaySE, TheForum.GameCode.SpecialEvents.ExitTutorialSE, TheForum.GameCode.SpecialEvents.JailItemSE, TheForum.GameCode.SpecialEvents.PieceCurtainTransitionSE, TheForum.GameCode.SpecialEvents.PieceParticlesSE, TheForum.GameCode.SpecialEvents.PieceScaleTransitionSE, TheForum.GameCode.SpecialEvents.PieceTransitionSE, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventDied, TheForum.GameCode.SpecialEvents.SpecialEventExpenses, TheForum.GameCode.SpecialEvents.SpecialEventIgnoreBoardSelection, TheForum.GameCode.SpecialEvents.SpecialEventJail, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale, TheForum.GameCode.SpecialEvents.SpecialEventUseFlag, TheForum.GameCode.SpecialEvents.StartCheatEventsSE, TheForum.GameCode.SpecialEvents.UnknownItemSE, TheForum.GameCode.SpecialEvents.WaitWhileUpdate, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, and TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.

Libraries.StringType TheForum.GameCode.SpecialEvents.BaseSpecialEvent.GetID ( )

Gets the ID that represents the event.

Return:
Value is the ID that represents the event.

Libraries.StringType TheForum.GameCode.SpecialEvents.BaseSpecialEvent.GetID ( )

Gets the ID that represents the event.

Return:
Value is the ID that represents the event.

bool TheForum.GameCode.SpecialEvents.BaseSpecialEvent.GetIgnoreIfFrozen ( )

Get weither the event should be ignored if the game is frozen.

Return:
Value is true if the event should be ignored when the game is frozen, false if not.

bool TheForum.GameCode.SpecialEvents.BaseSpecialEvent.GetIgnoreIfPaused ( )

Get weither the event should be ignored if the game is paused.

Return:
Value is true if the event should be ignored when the game is paused, false if not.

abstract bool TheForum.GameCode.SpecialEvents.BaseSpecialEvent.IsFinished ( ) [pure virtual]
bool TheForum.GameCode.SpecialEvents.BaseSpecialEvent.IsFinished ( )
void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.RemoveFlag ( Libraries.StringType  flag) [protected]

Remove the first instance of the given flag.

flag - Flag to remove.
void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.RemoveFlag ( Libraries.StringType  flag) [protected]

Remove the first instance of the given flag.

flag - Flag to remove.
void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.RemoveFlagOccurences ( Libraries.StringType  flag) [protected]

Remove all occurences of the given flag.

flag - Flag to remove.
void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.RemoveFlagOccurences ( Libraries.StringType  flag) [protected]

Remove all occurences of the given flag.

flag - Flag to remove.
abstract void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [pure virtual]

Renders the event.

device - Device to render with.

Implemented in TheForum.GameCode.LifeChoice.BaseLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetCrookedAccountentLifeChoice, TheForum.GameCode.LifeChoice.GetJobLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetMarriedLifeChoiceEvent, TheForum.GameCode.LifeChoice.MarriedLifeChoiceEvent, TheForum.GameCode.SpecialEvents.BaseTransitionSE, TheForum.GameCode.SpecialEvents.ChangeMusicVolumeSE, TheForum.GameCode.SpecialEvents.ExitGameplaySE, TheForum.GameCode.SpecialEvents.ExitTutorialSE, TheForum.GameCode.SpecialEvents.JailItemSE, TheForum.GameCode.SpecialEvents.PieceCurtainTransitionSE, TheForum.GameCode.SpecialEvents.PieceParticlesSE, TheForum.GameCode.SpecialEvents.PieceScaleTransitionSE, TheForum.GameCode.SpecialEvents.PieceTransitionSE, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventDied, TheForum.GameCode.SpecialEvents.SpecialEventExpenses, TheForum.GameCode.SpecialEvents.SpecialEventIgnoreBoardSelection, TheForum.GameCode.SpecialEvents.SpecialEventJail, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale, TheForum.GameCode.SpecialEvents.SpecialEventUseFlag, TheForum.GameCode.SpecialEvents.StartCheatEventsSE, TheForum.GameCode.SpecialEvents.UnknownItemSE, TheForum.GameCode.SpecialEvents.WaitWhileUpdate, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, and TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.

abstract void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [pure virtual]

Renders the event.

device - Device to render with.

Implemented in TheForum.GameCode.LifeChoice.BaseLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetCrookedAccountentLifeChoice, TheForum.GameCode.LifeChoice.GetJobLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetMarriedLifeChoiceEvent, TheForum.GameCode.LifeChoice.MarriedLifeChoiceEvent, TheForum.GameCode.SpecialEvents.BaseTransitionSE, TheForum.GameCode.SpecialEvents.ChangeMusicVolumeSE, TheForum.GameCode.SpecialEvents.ExitGameplaySE, TheForum.GameCode.SpecialEvents.ExitTutorialSE, TheForum.GameCode.SpecialEvents.JailItemSE, TheForum.GameCode.SpecialEvents.PieceCurtainTransitionSE, TheForum.GameCode.SpecialEvents.PieceParticlesSE, TheForum.GameCode.SpecialEvents.PieceScaleTransitionSE, TheForum.GameCode.SpecialEvents.PieceTransitionSE, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventDied, TheForum.GameCode.SpecialEvents.SpecialEventExpenses, TheForum.GameCode.SpecialEvents.SpecialEventIgnoreBoardSelection, TheForum.GameCode.SpecialEvents.SpecialEventJail, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale, TheForum.GameCode.SpecialEvents.SpecialEventUseFlag, TheForum.GameCode.SpecialEvents.StartCheatEventsSE, TheForum.GameCode.SpecialEvents.UnknownItemSE, TheForum.GameCode.SpecialEvents.WaitWhileUpdate, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, and TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.

virtual void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.RunAsFinished ( ) [virtual]

Set the special event as finished. Will run the finished delegate, if one is stored.

void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.RunFinishedDelegate ( ) [protected]

Run the finished delegate without setting the finished flag.

virtual void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.SetAsFinished ( ) [virtual]

Set the special event as finished. Doesn't run the finished delegate.

void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.SetIgnoreIfFrozen ( bool  ignore)

Set weither the event should be ignored when the game is frozen.

ignore - Value is true if the event should be ignored if the game is frozen, false if not.
void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.SetIgnoreIfPaused ( bool  ignore)

Set weither the event should be ignored when the game is paused.

ignore - Value is true if the event should be ignored if the game is paused, false if not.
void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.SetRunOnFinish ( Libraries.CallbackDelegate  delegateUse,
Object  objData 
)

Set the delegate to run and the data to pass when the event finishes. Can be null if you don't want anything to happen.

abstract void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.Update ( int  timePassed,
Libraries.AssetManager  assetM 
) [pure virtual]

Update the event.

timePassed - How much time to use for the update.
assetM - Asset manager to use.

Implemented in TheForum.GameCode.LifeChoice.GetCrookedAccountentLifeChoice, TheForum.GameCode.LifeChoice.GetJobLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetMarriedLifeChoiceEvent, TheForum.GameCode.LifeChoice.MarriedLifeChoiceEvent, TheForum.GameCode.SpecialEvents.BaseTransitionSE, TheForum.GameCode.SpecialEvents.ChangeMusicVolumeSE, TheForum.GameCode.SpecialEvents.ExitGameplaySE, TheForum.GameCode.SpecialEvents.ExitTutorialSE, TheForum.GameCode.SpecialEvents.JailItemSE, TheForum.GameCode.SpecialEvents.PieceCurtainTransitionSE, TheForum.GameCode.SpecialEvents.PieceParticlesSE, TheForum.GameCode.SpecialEvents.PieceScaleTransitionSE, TheForum.GameCode.SpecialEvents.PieceTransitionSE, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventDied, TheForum.GameCode.SpecialEvents.SpecialEventExpenses, TheForum.GameCode.SpecialEvents.SpecialEventIgnoreBoardSelection, TheForum.GameCode.SpecialEvents.SpecialEventJail, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale, TheForum.GameCode.SpecialEvents.SpecialEventUseFlag, TheForum.GameCode.SpecialEvents.StartCheatEventsSE, TheForum.GameCode.SpecialEvents.UnknownItemSE, TheForum.GameCode.SpecialEvents.WaitWhileUpdate, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, and TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.

abstract void TheForum.GameCode.SpecialEvents.BaseSpecialEvent.Update ( int  timePassed,
Libraries.AssetManager  assetM 
) [pure virtual]

Update the event.

timePassed - How much time to use for the update.
assetM - Asset manager to use.

Implemented in TheForum.GameCode.LifeChoice.GetCrookedAccountentLifeChoice, TheForum.GameCode.LifeChoice.GetJobLifeChoiceEvent, TheForum.GameCode.LifeChoice.GetMarriedLifeChoiceEvent, TheForum.GameCode.LifeChoice.MarriedLifeChoiceEvent, TheForum.GameCode.SpecialEvents.BaseTransitionSE, TheForum.GameCode.SpecialEvents.ChangeMusicVolumeSE, TheForum.GameCode.SpecialEvents.ExitGameplaySE, TheForum.GameCode.SpecialEvents.ExitTutorialSE, TheForum.GameCode.SpecialEvents.JailItemSE, TheForum.GameCode.SpecialEvents.PieceCurtainTransitionSE, TheForum.GameCode.SpecialEvents.PieceParticlesSE, TheForum.GameCode.SpecialEvents.PieceScaleTransitionSE, TheForum.GameCode.SpecialEvents.PieceTransitionSE, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventDied, TheForum.GameCode.SpecialEvents.SpecialEventExpenses, TheForum.GameCode.SpecialEvents.SpecialEventIgnoreBoardSelection, TheForum.GameCode.SpecialEvents.SpecialEventJail, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale, TheForum.GameCode.SpecialEvents.SpecialEventUseFlag, TheForum.GameCode.SpecialEvents.StartCheatEventsSE, TheForum.GameCode.SpecialEvents.UnknownItemSE, TheForum.GameCode.SpecialEvents.WaitWhileUpdate, TheForum.GameCode.SpecialEvents.SpecialEventBandwagon, TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, TheForum.GameCode.SpecialEvents.SpecialEventPostMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventPostScaleMessage, TheForum.GameCode.SpecialEvents.SpecialEventProbation, TheForum.GameCode.SpecialEvents.SpecialEventReceivePieces, TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesMove, and TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.


Member Data Documentation

Whether the event should update if it's update function is called. Value is true if it should, false if not.

Delegate to run when the special event is marked as finished.

Data to pass when calling the finished delegate.

Flags that the event has. Flags can be checked by the game to cause events to happen/not happen.

ID that represents the event. This should be unique to the event or null. It has to be non-null if you want to be able to access it by ID.

Value is true if the event should be ignored when the game is frozen, false if not. If ignored then it shouldn't be told to update or render.

Value is true if the event should be ignored when the game is paused, false if not. If ignored then it shouldn't be told to update or render.

Flag to represent if the special event is finished. Value should be true if it is, false if not.

Reimplemented in TheForum.GameCode.SpecialEvents.SpecialEventLowContent, TheForum.GameCode.SpecialEvents.SpecialEventPermaban, and TheForum.GameCode.SpecialEvents.SpecialEventPostOppScaleMessage.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties