Class StateManagerMetadata

Defines properties and message types for StateManager.

Property Types

See also PropertyType
StateManagerMetadata.StateManagerLongestPathProperty

The longest path is selected for transformation animations.

Message Types

See also MessageType
StateManagerMetadata.GoToStateMessage

Attempts to go to a state in a state manager

Arguments: StateManagerMetadata.GoToStateMessageArguments

StateManagerMetadata.GoToNextDefinedStateMessage

Attempts to go to a state that is defined after the current one in a state manager

Arguments: StateManagerMetadata.GoToNextDefinedStateMessageArguments

StateManagerMetadata.GoToPreviousDefinedStateMessage

Attempts to go to a state that is defined before the current one in a state manager

Arguments: StateManagerMetadata.GoToPreviousDefinedStateMessageArguments

StateManagerMetadata.EnteredStateMessage

Occurs when a state manager has entered a state.

Arguments: StateManagerMetadata.EnteredStateMessageArguments

StateManagerMetadata.LeftStateMessage

Occurs when a state manager has left a state.

Arguments: StateManagerMetadata.LeftStateMessageArguments

StateManagerMetadata.TransitionStartedMessage

Occurs when a state manager begins a transition to a state.

Arguments: StateManagerMetadata.TransitionStartedMessageArguments

StateManagerMetadata.TransitionFinishedMessage

Occurs when a state manager finishes a transition to a state.

Arguments: StateManagerMetadata.TransitionFinishedMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

StateManagerMetadata.EnteredStateMessageArguments

EnteredStateProperty

State Manager State Entered

Example
local value = arguments:getEnteredStateProperty()
arguments:setEnteredStateProperty(value)

StateManagerMetadata.GoToDefinedStateMessageArguments

LoopStatesProperty

Whether to go back to the first state after reaching the last state.

Example
local value = arguments:getLoopStatesProperty()
arguments:setLoopStatesProperty(value)

StateManagerMetadata.GoToNextDefinedStateMessageArguments

StateManagerMetadata.GoToPreviousDefinedStateMessageArguments

StateManagerMetadata.GoToStateMessageArguments

StateProperty

State Manager State

Example
local value = arguments:getStateProperty()
arguments:setStateProperty(value)

StateManagerMetadata.LeftStateMessageArguments

LeftStateProperty

State Manager State Left

Example
local value = arguments:getLeftStateProperty()
arguments:setLeftStateProperty(value)

StateManagerMetadata.StateChangeMessageArguments

ImmediateProperty

Whether to change the state instantly, without playing a transition animation.

Example
local value = arguments:getImmediateProperty()
arguments:setImmediateProperty(value)

StateManagerMetadata.StateManagerMessageArguments

StateGroupProperty

The state group that contains the state to which you want to transition.

Example
local value = arguments:getStateGroupProperty()
arguments:setStateGroupProperty(value)

StateManagerMetadata.TransitionFinishedMessageArguments

StateManagerMetadata.TransitionMessageArguments

SourceStateProperty

Source State for the transition

Example
local value = arguments:getSourceStateProperty()
arguments:setSourceStateProperty(value)
TargetStateProperty

Target State for the transition

Example
local value = arguments:getTargetStateProperty()
arguments:setTargetStateProperty(value)

StateManagerMetadata.TransitionStartedMessageArguments