State Class

State Class

Defines a state in a state machine.

Inheritance Hierarchy

SystemObject
DigitalRune.Game.StatesState

Namespace: DigitalRune.Game.States
Assembly: DigitalRune.Game (in DigitalRune.Game.dll) Version: 1.4.0.0 (1.4.0.14427)

Syntax

public class State : INamedObject

Public Class State
	Implements INamedObject

public ref class State : INamedObject

type State =  
    class
        interface INamedObject
    end

The State type exposes the following members.

Constructors

	Name	Description
	State	Initializes a new instance of the State class.
	State(String)	Initializes a new instance of the State class.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnEnter	Raises the Enter event.
	OnExit	Raises the Exit event.
	OnUpdate	Raises the Update event.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	IsActive	Gets a value indicating whether this state is active.
	Name	Gets or sets the name of the state.
	Owner	Gets the state collection that owns this state.
	ParallelSubStates	Gets the parallel sub-state collections.
	Transitions	Gets the transitions.

Events

	Name	Description
	Enter	Occurs when the state is entered.
	Exit	Occurs when the state is exited.
	Update	Occurs when the state is updated.

Remarks

Important note: Each state must be given a name that is unique within the StateCollection in which it will be used.