OnBeginState

From Creation Kit
Jump to: navigation, search

Member of: Any and all scripts.

Event called when the state the event is in has just been switched to. Note that this event will not be called for an auto state when the object is initialized.

This event will be called if the object it sent to a state that is not defined, including states that cannot be defined such as those with invalid names (e.g. "State #3" or "").

This event will also be called by any subsequent GoToState() calls even if the script is already in that state.

Syntax

Event OnBeginState()

Parameters

None

Example

State Running
  Event OnBeginState()
    Debug.Trace("Entered the running state!")
  EndEvent
EndState

See Also

OnEndState