Skip to content

USMStateMachineInstance

Module: SMSystem

#include <SMStateMachineInstance.h>

Inherits from USMStateInstance_Base, USMNodeInstance, UObject

Description

class USMStateMachineInstance;

The base class for state machine nodes. These are different from regular state machines (SMInstance) in that they can be assigned to a state machine directly either in the class defaults or in the details panel of a nested state machine node. Think of this as giving a state machine a 'type' which allows you to identify it in rule behavior. This is still considered a state as well which allows access to hooking into Start, Update, and End events even when placed as a nested state machine.

Public Functions

Name
USMStateMachineInstance()
virtual void PostLoad() override
void OnStateMachineCompleted()
images/classes/SMStateMachineInstance/img/nd_img_OnStateMachineCompleted.png
void OnEndStateReached()
images/classes/SMStateMachineInstance/img/nd_img_OnEndStateReached.png
void OnStateInitialized()
images/classes/SMStateMachineInstance/img/nd_img_OnStateInitialized.png
void OnStateShutdown()
images/classes/SMStateMachineInstance/img/nd_img_OnStateShutdown.png
void GetAllStateInstances(TArray< USMStateInstance_Base * > & StateInstances) const
images/classes/SMStateMachineInstance/img/nd_img_GetAllStateInstances.png
USMStateInstance_Base * GetContainedStateByName(const FString & StateName) const
images/classes/SMStateMachineInstance/img/nd_img_GetContainedStateByName.png
void GetEntryStates(TArray< USMStateInstance_Base * > & EntryStates) const
images/classes/SMStateMachineInstance/img/nd_img_GetEntryStates.png
void GetActiveStates(TArray< USMStateInstance_Base * > & ActiveStates) const
images/classes/SMStateMachineInstance/img/nd_img_GetActiveStates.png
USMInstance * GetStateMachineReference() const
images/classes/SMStateMachineInstance/img/nd_img_GetStateMachineReference.png
virtual const FSMNode_Base * GetOwningNodeContainer() const override
bool IsStateMachineInEndState() const
images/classes/SMStateMachineInstance/img/nd_img_IsStateMachineInEndState.png
const FSMStateMachineNodePlacementValidator & GetAllowedNodes() const
const FSMStateMachineNodePlacementValidator & GetAllowedStates() const
bool GetWaitForEndState() const
images/classes/SMStateMachineInstance/img/nd_img_GetWaitForEndState.png
void SetWaitForEndState(const bool bValue)
images/classes/SMStateMachineInstance/img/nd_img_SetWaitForEndState.png
bool GetReuseCurrentState() const
images/classes/SMStateMachineInstance/img/nd_img_GetReuseCurrentState.png
void SetReuseCurrentState(const bool bValue)
images/classes/SMStateMachineInstance/img/nd_img_SetReuseCurrentState.png
bool GetReuseIfNotEndState() const
images/classes/SMStateMachineInstance/img/nd_img_GetReuseIfNotEndState.png
void SetReuseIfNotEndState(const bool bValue)
images/classes/SMStateMachineInstance/img/nd_img_SetReuseIfNotEndState.png

Protected Functions

Name
virtual void OnStateMachineCompleted_Implementation()
virtual void OnEndStateReached_Implementation()
virtual void OnStateInitialized_Implementation()
virtual void OnStateShutdown_Implementation()

Protected Attributes

Name
FSMStateMachineNodePlacementValidator NodePlacementRules
FSMStateMachineNodePlacementValidator StatePlacementRules_DEPRECATED

Additional inherited members

Public Functions inherited from USMStateInstance_Base

Name
USMStateInstance_Base()
virtual bool IsInEndState() const override
void OnStateBegin()
images/classes/SMStateInstance_Base/img/nd_img_OnStateBegin.png
void OnStateUpdate(float DeltaSeconds)
images/classes/SMStateInstance_Base/img/nd_img_OnStateUpdate.png
void OnStateEnd()
images/classes/SMStateInstance_Base/img/nd_img_OnStateEnd.png
bool IsEndState() const
images/classes/SMStateInstance_Base/img/nd_img_IsEndState.png
void GetStateInfo(FSMStateInfo & State) const
images/classes/SMStateInstance_Base/img/nd_img_GetStateInfo.png
bool IsStateMachine() const
images/classes/SMStateInstance_Base/img/nd_img_IsStateMachine.png
bool IsEntryState() const
images/classes/SMStateInstance_Base/img/nd_img_IsEntryState.png
void SetActive(bool bValue, bool bSetAllParents =false, bool bActivateNow =true)
images/classes/SMStateInstance_Base/img/nd_img_SetActive.png
void EvaluateTransitions()
images/classes/SMStateInstance_Base/img/nd_img_EvaluateTransitions.png
bool GetOutgoingTransitions(TArray< USMTransitionInstance * > & Transitions, bool bExcludeAlwaysFalse =true) const
images/classes/SMStateInstance_Base/img/nd_img_GetOutgoingTransitions.png
bool GetIncomingTransitions(TArray< USMTransitionInstance * > & Transitions, bool bExcludeAlwaysFalse =true) const
images/classes/SMStateInstance_Base/img/nd_img_GetIncomingTransitions.png
USMTransitionInstance * GetTransitionToTake() const
images/classes/SMStateInstance_Base/img/nd_img_GetTransitionToTake.png
bool SwitchToLinkedState(USMStateInstance_Base * NextStateInstance, bool bRequireTransitionToPass =true, bool bActivateNow =true)
images/classes/SMStateInstance_Base/img/nd_img_SwitchToLinkedState.png
bool SwitchToLinkedStateByName(const FString & NextStateName, bool bRequireTransitionToPass =true, bool bActivateNow =true)
images/classes/SMStateInstance_Base/img/nd_img_SwitchToLinkedStateByName.png
bool SwitchToLinkedStateByTransition(USMTransitionInstance * TransitionInstance, bool bRequireTransitionToPass =true, bool bActivateNow =true)
images/classes/SMStateInstance_Base/img/nd_img_SwitchToLinkedStateByTransition.png
bool SwitchToLinkedStateByTransitionName(const FString & TransitionName, bool bRequireTransitionToPass =true, bool bActivateNow =true)
images/classes/SMStateInstance_Base/img/nd_img_SwitchToLinkedStateByTransitionName.png
USMTransitionInstance * GetTransitionByIndex(int32 Index) const
images/classes/SMStateInstance_Base/img/nd_img_GetTransitionByIndex.png
USMTransitionInstance * GetOutgoingTransitionByName(const FString & Name) const
images/classes/SMStateInstance_Base/img/nd_img_GetOutgoingTransitionByName.png
USMTransitionInstance * GetIncomingTransitionByName(const FString & Name) const
images/classes/SMStateInstance_Base/img/nd_img_GetIncomingTransitionByName.png
USMStateInstance_Base * GetNextStateByTransitionIndex(int32 Index) const
images/classes/SMStateInstance_Base/img/nd_img_GetNextStateByTransitionIndex.png
USMStateInstance_Base * GetNextStateByName(const FString & StateName) const
images/classes/SMStateInstance_Base/img/nd_img_GetNextStateByName.png
USMStateInstance_Base * GetPreviousStateByName(const FString & StateName) const
images/classes/SMStateInstance_Base/img/nd_img_GetPreviousStateByName.png
USMStateInstance_Base * GetPreviousActiveState() const
images/classes/SMStateInstance_Base/img/nd_img_GetPreviousActiveState.png
USMTransitionInstance * GetPreviousActiveTransition() const
images/classes/SMStateInstance_Base/img/nd_img_GetPreviousActiveTransition.png
bool AreAllOutgoingTransitionsFromAnAnyState() const
images/classes/SMStateInstance_Base/img/nd_img_AreAllOutgoingTransitionsFromAnAnyState.png
bool AreAllIncomingTransitionsFromAnAnyState() const
images/classes/SMStateInstance_Base/img/nd_img_AreAllIncomingTransitionsFromAnAnyState.png
const FDateTime & GetStartTime() const
images/classes/SMStateInstance_Base/img/nd_img_GetStartTime.png
float GetServerTimeInState(bool & bOutUsedLocalTime) const
images/classes/SMStateInstance_Base/img/nd_img_GetServerTimeInState.png
void GetAllNodesOfType(TArray< USMNodeInstance * > & OutNodes, TSubclassOf< USMNodeInstance > NodeClass, bool bIncludeChildren =true, const TArray< UClass * > & StopIfTypeIsNot =TArray< UClass * >()) const
const FLinearColor & GetEndStateColor() const
bool ShouldDisplayNameWidget() const
bool ShouldUseDisplayNameOnly() const
const FSMStateConnectionValidator & GetAllowedConnections() const
virtual bool IsRegisteredWithContextMenu() const
virtual bool HideFromContextMenuIfRulesFail() const
bool GetAlwaysUpdate() const
images/classes/SMStateInstance_Base/img/nd_img_GetAlwaysUpdate.png
void SetAlwaysUpdate(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetAlwaysUpdate.png
bool GetDisableTickTransitionEvaluation() const
images/classes/SMStateInstance_Base/img/nd_img_GetDisableTickTransitionEvaluation.png
void SetDisableTickTransitionEvaluation(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetDisableTickTransitionEvaluation.png
bool GetDefaultToParallel() const
images/classes/SMStateInstance_Base/img/nd_img_GetDefaultToParallel.png
void SetDefaultToParallel(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetDefaultToParallel.png
bool GetAllowParallelReentry() const
images/classes/SMStateInstance_Base/img/nd_img_GetAllowParallelReentry.png
void SetAllowParallelReentry(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetAllowParallelReentry.png
bool GetStayActiveOnStateChange() const
images/classes/SMStateInstance_Base/img/nd_img_GetStayActiveOnStateChange.png
void SetStayActiveOnStateChange(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetStayActiveOnStateChange.png
bool GetEvalTransitionsOnStart() const
images/classes/SMStateInstance_Base/img/nd_img_GetEvalTransitionsOnStart.png
void SetEvalTransitionsOnStart(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetEvalTransitionsOnStart.png
bool GetExcludeFromAnyState() const
images/classes/SMStateInstance_Base/img/nd_img_GetExcludeFromAnyState.png
void SetExcludeFromAnyState(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetExcludeFromAnyState.png
bool GetCanBeEndState() const
images/classes/SMStateInstance_Base/img/nd_img_GetCanBeEndState.png
void SetCanBeEndState(const bool bValue)
images/classes/SMStateInstance_Base/img/nd_img_SetCanBeEndState.png
FName GetHideFromContextMenuIfRulesFailPropertyName()
FName GetRegisteredWithContextMenuPropertyName()

Protected Functions inherited from USMStateInstance_Base

Name
virtual void OnStateBegin_Implementation()
virtual void OnStateUpdate_Implementation(float DeltaSeconds)
virtual void OnStateEnd_Implementation()

Public Attributes inherited from USMStateInstance_Base

Name
uint8 bEvalGraphsOnStart
uint8 bEvalGraphsOnUpdate
uint8 bEvalGraphsOnEnd
uint8 bEvalGraphsOnRootStateMachineStart
uint8 bEvalGraphsOnRootStateMachineStop
FOnStateBeginSignature OnStateBeginEvent
FOnStateBeginSignature OnPostStateBeginEvent
FOnStateUpdateSignature OnStateUpdateEvent
FOnStateEndSignature OnStateEndEvent

Protected Attributes inherited from USMStateInstance_Base

Name
FLinearColor NodeEndStateColor
FSMStateConnectionValidator ConnectionRules
uint16 bHideFromContextMenuIfRulesFail
uint16 bRegisterWithContextMenu
uint16 bShowDisplayNameOnly
uint16 bDisplayNameWidget

Friends inherited from USMStateInstance_Base

Name
class USMGraphNode_StateNodeBase

Public Functions inherited from USMNodeInstance

Name
USMNodeInstance()
virtual void Serialize(FArchive & Ar) override
virtual UWorld * GetWorld() const override
virtual void BeginDestroy() override
virtual UObject * GetContext() const override
images/classes/SMNodeInstance/img/nd_img_GetContext.png
virtual void NativeInitialize()
virtual void NativeShutdown()
void OnRootStateMachineStart()
images/classes/SMNodeInstance/img/nd_img_OnRootStateMachineStart.png
void OnRootStateMachineStop()
images/classes/SMNodeInstance/img/nd_img_OnRootStateMachineStop.png
void RunConstructionScript()
bool ShouldSkipNativeEditorConstructionScripts() const
USMInstance * GetStateMachineInstance(bool bTopMostInstance =false) const
images/classes/SMNodeInstance/img/nd_img_GetStateMachineInstance.png
void SetOwningNode(FSMNode_Base * Node, bool bInIsEditorExecution =false)
const FSMNode_Base * GetOwningNode() const
T * GetOwningNodeAs() const
USMStateMachineInstance * GetOwningStateMachineNodeInstance() const
images/classes/SMNodeInstance/img/nd_img_GetOwningStateMachineNodeInstance.png
TScriptInterface< ISMStateMachineNetworkedInterface > GetNetworkInterface() const
images/classes/SMNodeInstance/img/nd_img_GetNetworkInterface.png
virtual float GetTimeInState() const
images/classes/SMNodeInstance/img/nd_img_GetTimeInState.png
virtual bool IsInEndState() const
virtual bool HasUpdated() const
images/classes/SMNodeInstance/img/nd_img_HasUpdated.png
bool IsActive() const
images/classes/SMNodeInstance/img/nd_img_IsActive.png
const FString & GetNodeName() const
images/classes/SMNodeInstance/img/nd_img_GetNodeName.png
const FGuid & GetGuid() const
images/classes/SMNodeInstance/img/nd_img_GetGuid.png
UTexture2D * GetNodeIcon() const
images/classes/SMNodeInstance/img/nd_img_GetNodeIcon.png
FVector2D GetNodeIconSize() const
images/classes/SMNodeInstance/img/nd_img_GetNodeIconSize.png
FLinearColor GetNodeIconTintColor() const
images/classes/SMNodeInstance/img/nd_img_GetNodeIconTintColor.png
void EvaluateGraphProperties(bool bTargetOnly =false)
images/classes/SMNodeInstance/img/nd_img_EvaluateGraphProperties.png
const FGuid & GetTemplateGuid() const
const FVector2D & GetNodePosition() const
images/classes/SMNodeInstance/img/nd_img_GetNodePosition.png
bool IsInitialized() const
images/classes/SMNodeInstance/img/nd_img_IsInitialized.png
bool IsInitializedAndReadyForInputEvents() const
FSMGraphProperty * FindExposedPropertyOverrideByName(const FName & VariableName) const
virtual void PostEditChangeProperty(FPropertyChangedEvent & PropertyChangedEvent) override
bool WasArrayPropertyModified(const FName & PropertyName) const
bool IsNodePinChanging() const
void SetDisplayName(FName NewDisplayName)
images/classes/SMNodeInstance/img/nd_img_SetDisplayName.png
void SetNodeDescriptionText(FText NewDescription)
images/classes/SMNodeInstance/img/nd_img_SetNodeDescriptionText.png
FText GetNodeDescriptionText() const
images/classes/SMNodeInstance/img/nd_img_GetNodeDescriptionText.png
void SetNodeColor(FLinearColor NewColor)
images/classes/SMNodeInstance/img/nd_img_SetNodeColor.png
void SetUseCustomColor(bool bValue)
images/classes/SMNodeInstance/img/nd_img_SetUseCustomColor.png
void SetUseCustomIcon(bool bValue)
images/classes/SMNodeInstance/img/nd_img_SetUseCustomIcon.png
void SetVariableReadOnly(FName VariableName, bool bSetIsReadOnly)
images/classes/SMNodeInstance/img/nd_img_SetVariableReadOnly.png
void SetVariableHidden(FName VariableName, bool bSetHidden)
images/classes/SMNodeInstance/img/nd_img_SetVariableHidden.png
bool IsEditorExecution() const
images/classes/SMNodeInstance/img/nd_img_IsEditorExecution.png
void WithExecutionEnvironment(ESMExecutionEnvironment & ExecutionEnvironment)
images/classes/SMNodeInstance/img/nd_img_WithExecutionEnvironment.png
TScriptInterface< ISMEditorGraphNodeInterface > GetOwningEditorGraphNode() const
images/classes/SMNodeInstance/img/nd_img_GetOwningEditorGraphNode.png
void K2_TryGetOwningEditorGraphNode(TScriptInterface< ISMEditorGraphNodeInterface > & EditorNode, ESMValidEditorNode & IsValidNode) const
images/classes/SMNodeInstance/img/nd_img_K2_TryGetOwningEditorGraphNode.png
bool IsInitializationThreadSafe() const
void ResetVariables()
images/classes/SMNodeInstance/img/nd_img_ResetVariables.png
bool GetResetVariablesOnInitialize() const
bool HasCustomColor() const
const FLinearColor & GetNodeColor() const
const FSMNodeDescription & GetNodeDescription() const
bool HasCustomIcon() const
FString GetNodeDisplayName() const
void SetTemplateGuid(const FGuid & NewTemplateGuid)
void SetIsThreadSafe(bool bNewValue)
void SetIsEditorThreadSafe(const bool bNewValue)
bool GetIsEditorThreadSafe() const
TEnumAsByte< ESMNodeInput::Type > GetInputType() const
int32 GetInputPriority() const
bool GetBlockInput() const
UInputComponent * GetInputComponent() const
images/classes/SMNodeInstance/img/nd_img_GetInputComponent.png
FName GetConstructionScriptFunctionName()
FName GetNodeDescriptionPropertyName()
FName GetHideFromDropDownIfRulesFailPropertyName()

Protected Functions inherited from USMNodeInstance

Name
virtual void OnRootStateMachineStart_Implementation()
virtual void OnRootStateMachineStop_Implementation()
void ConstructionScript()
images/classes/SMNodeInstance/img/nd_img_ConstructionScript.png
FSMGraphProperty * FindOrAddExposedPropertyOverrideByName(const FName & VariableName)
void OnPreCompileValidate(USMCompilerLog * CompilerLog) const
virtual void OnPreCompileValidate_Implementation(USMCompilerLog * CompilerLog) const
virtual void ConstructionScript_Implementation()
virtual UTexture2D * GetNodeIcon_Implementation() const
virtual FVector2D GetNodeIconSize_Implementation() const
virtual FLinearColor GetNodeIconTintColor_Implementation() const
void EnableInput()
Input.
void DisableInput()
void OnContextPawnControllerChanged(APawn * Pawn, AController * NewController)

Public Attributes inherited from USMNodeInstance

Name
TArray< FSMGraphProperty > ExposedPropertyOverrides
uint8 bEvalDefaultProperties
uint8 bAutoEvalExposedProperties

Protected Attributes inherited from USMNodeInstance

Name
bool bSkipNativeEditorConstructionScripts
TObjectPtr< UTexture2D > NodeIcon
FVector2D NodeIconSize
FLinearColor NodeIconTintColor
bool bResetVariablesOnInitialize
FSMNodeDescription NodeDescription
FLinearColor NodeColor
uint8 bDisplayCustomIcon
uint8 bUseCustomColors
uint8 bHideFromDropDownIfRulesFail
TObjectPtr< UInputComponent > InputComponent
TEnumAsByte< ESMNodeInput::Type > AutoReceiveInput
int32 InputPriority
uint8 bBlockInput

Friends inherited from USMNodeInstance

Name
class USMGraphNode_StateNode
class USMGraphNode_TransitionEdge
struct FSMNode_Base(FSMNode_Base )
class USMGraphNode_Base
class USMGraphK2Node_PropertyNode_Base

Public Functions Documentation

function USMStateMachineInstance

USMStateMachineInstance()

function PostLoad

virtual void PostLoad() override

function OnStateMachineCompleted

void OnStateMachineCompleted()

images/classes/SMStateMachineInstance/img/nd_img_OnStateMachineCompleted.png

Called after the state machine has completed its internal states.


function OnEndStateReached

void OnEndStateReached()

images/classes/SMStateMachineInstance/img/nd_img_OnEndStateReached.png

Called when an end state has been reached.


function OnStateInitialized

void OnStateInitialized()

images/classes/SMStateMachineInstance/img/nd_img_OnStateInitialized.png

Called before OnStateBegin and before transitions are initialized.


function OnStateShutdown

void OnStateShutdown()

images/classes/SMStateMachineInstance/img/nd_img_OnStateShutdown.png

Called after OnStateEnd and after transitions are shutdown.


function GetAllStateInstances

void GetAllStateInstances(
    TArray< USMStateInstance_Base * > & StateInstances
) const

images/classes/SMStateMachineInstance/img/nd_img_GetAllStateInstances.png

Retrieve all contained state instances defined within the state machine graph this instance represents. These can be states, state machines, and conduits.

This does not include nested states in sub state machines.


function GetContainedStateByName

USMStateInstance_Base * GetContainedStateByName(
    const FString & StateName
) const

images/classes/SMStateMachineInstance/img/nd_img_GetContainedStateByName.png

Retrieve an immediate state owned by this state machine node in O(1) time. This will not retrieve nested states.

Parameters:

StateName
The name of the state node to search for.

Return: The state instance or nullptr.


function GetEntryStates

void GetEntryStates(
    TArray< USMStateInstance_Base * > & EntryStates
) const

images/classes/SMStateMachineInstance/img/nd_img_GetEntryStates.png

Return the entry states of the state machine. Generally one unless parallel states are used.


function GetActiveStates

void GetActiveStates(
    TArray< USMStateInstance_Base * > & ActiveStates
) const

images/classes/SMStateMachineInstance/img/nd_img_GetActiveStates.png

Return all states active within this state machine node.


function GetStateMachineReference

USMInstance * GetStateMachineReference() const

images/classes/SMStateMachineInstance/img/nd_img_GetStateMachineReference.png

Return an SMInstance reference if one is assigned. This will be null if this is not a state machine reference.


function GetOwningNodeContainer

virtual const FSMNode_Base * GetOwningNodeContainer() const override

Special handling to retrieve the real FSM node in the event this is a state machine reference.

Reimplements: USMNodeInstance::GetOwningNodeContainer


function IsStateMachineInEndState

bool IsStateMachineInEndState() const

images/classes/SMStateMachineInstance/img/nd_img_IsStateMachineInEndState.png

If this state machine node is in an end state.


function GetAllowedNodes

inline const FSMStateMachineNodePlacementValidator & GetAllowedNodes() const

Retrieve the node placement rules for this state machine.


function GetAllowedStates

inline const FSMStateMachineNodePlacementValidator & GetAllowedStates() const

Deprecated:

Use GetAllowedNodes() instead.


function GetWaitForEndState

bool GetWaitForEndState() const

images/classes/SMStateMachineInstance/img/nd_img_GetWaitForEndState.png

Public getter for bWaitForEndState.


function SetWaitForEndState

void SetWaitForEndState(
    const bool bValue
)

images/classes/SMStateMachineInstance/img/nd_img_SetWaitForEndState.png

Public setter for bWaitForEndState.


function GetReuseCurrentState

bool GetReuseCurrentState() const

images/classes/SMStateMachineInstance/img/nd_img_GetReuseCurrentState.png

Public getter for bReuseCurrentState.


function SetReuseCurrentState

void SetReuseCurrentState(
    const bool bValue
)

images/classes/SMStateMachineInstance/img/nd_img_SetReuseCurrentState.png

Public setter for bReuseCurrentState.


function GetReuseIfNotEndState

bool GetReuseIfNotEndState() const

images/classes/SMStateMachineInstance/img/nd_img_GetReuseIfNotEndState.png

Public getter for bReuseIfNotEndState.


function SetReuseIfNotEndState

void SetReuseIfNotEndState(
    const bool bValue
)

images/classes/SMStateMachineInstance/img/nd_img_SetReuseIfNotEndState.png

Public setter for bReuseIfNotEndState.


Protected Functions Documentation

function OnStateMachineCompleted_Implementation

inline virtual void OnStateMachineCompleted_Implementation()

function OnEndStateReached_Implementation

inline virtual void OnEndStateReached_Implementation()

function OnStateInitialized_Implementation

inline virtual void OnStateInitialized_Implementation()

function OnStateShutdown_Implementation

inline virtual void OnStateShutdown_Implementation()

Protected Attributes Documentation

variable NodePlacementRules

FSMStateMachineNodePlacementValidator NodePlacementRules;

Define what types of nodes are allowed or disallowed. Default is all.


variable StatePlacementRules_DEPRECATED

FSMStateMachineNodePlacementValidator StatePlacementRules_DEPRECATED;

Deprecated:

Use NodePlacementRules instead.


Private Attributes Documentation

variable bWaitForEndState

uint8 bWaitForEndState;

Wait for an end state to be hit before evaluating transitions or being considered an end state itself.


variable bReuseCurrentState

uint8 bReuseCurrentState;

When true the current state is reused on end/start. When false the current state is cleared on end and the initial state used on start. References will inherit this behavior.


variable bReuseIfNotEndState

uint8 bReuseIfNotEndState;

Do not reuse if in an end state. References will inherit this behavior.