C# Class Terrarium.Game.EngineStateChangedEventArgs

An EngineStateChangeEvent is raised when some interesting change in state occurs such as an animal being born or dying or being teleported into your world or out. Its main purpose is to provide some useful feedback to the UI This EventArgs describes that event. It contains the type of state change and a short description and a long description

Inheritance: System.EventArgs

Datei anzeigen Open project: eugeniomiro/Terrarium Class Usage Examples

Public Methods

Method	Description
AnimalArrived ( OrganismBase.OrganismState organismState ) : EngineStateChangedEventArgs	Creates a new event relating to a creature arriving.
AnimalDestroyed ( OrganismBase.OrganismState organismState, PopulationChangeReason reason ) : EngineStateChangedEventArgs	Creates a new event relating to a creature being destroyed.
EngineStateChangedEventArgs ( EngineStateChangeType stateChange, string shortDescription ) : System	Creates a new set of event arguments for a state change with short message.
EngineStateChangedEventArgs ( EngineStateChangeType stateChange, string shortDescription, string longDescription ) : System	Creates a new set of event arguments for a state change with short and long messages.

Method Details

AnimalArrived() public static method

Creates a new event relating to a creature arriving.

public static AnimalArrived ( OrganismBase.OrganismState organismState ) : EngineStateChangedEventArgs
organismState	OrganismBase.OrganismState	The creature arriving.
return	EngineStateChangedEventArgs

AnimalDestroyed() public static method

Creates a new event relating to a creature being destroyed.

public static AnimalDestroyed ( OrganismBase.OrganismState organismState, PopulationChangeReason reason ) : EngineStateChangedEventArgs
organismState	OrganismBase.OrganismState	The creature being destroyed.
reason	PopulationChangeReason	The reason the creature is being destroyed.
return	EngineStateChangedEventArgs

EngineStateChangedEventArgs() public method

Creates a new set of event arguments for a state change with short message.

public EngineStateChangedEventArgs ( EngineStateChangeType stateChange, string shortDescription ) : System
stateChange	EngineStateChangeType	The state change type
shortDescription	string	A short description
return	System

EngineStateChangedEventArgs() public method

Creates a new set of event arguments for a state change with short and long messages.

public EngineStateChangedEventArgs ( EngineStateChangeType stateChange, string shortDescription, string longDescription ) : System
stateChange	EngineStateChangeType	The state change type
shortDescription	string	A short description
longDescription	string	A detailed description
return	System