1. Epic GamesDeveloper
  3. UStateTreeState

UStateTreeState

Editor representation of a state in StateTree

API > API/Plugins > API/Plugins/StateTreeEditorModule

Inheritance Hierarchy

References

   
Module StateTreeEditorModule
Header /Engine/Plugins/Runtime/StateTree/Source/StateTreeEditorModule/Public/StateTreeState.h
Include #include "StateTreeState.h"

Syntax

UCLASS (BlueprintType, EditInlineNew, CollapseCategories)  
class UStateTreeState :  
    public UObject ,  
    public IStateTreeSchemaProvider

Remarks

Editor representation of a state in StateTree

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly bool bCheckPrerequisitesWhenActivatingChildDirectly Should state's required event and enter conditions be evaluated when transition leads directly to it's child.
Public variable UProperty Category, EditDefaultsOnly bool bEnabled  
Public variable UProperty Meta bool bExpanded  
Public variable UProperty Category, EditDefaultsOnly, Meta bool bHasRequiredEventToEnter  
Public variable UProperty TArray< TObjectPtr< UStateTreeState > > Children  
Public variable UProperty Category, EditDefaultsOnly displayname FStateTreeEditorColorRef ColorRef Display color of the State
Public variable UProperty Category, EditDefaultsOnly, Meta TArray< FStateTreeEditorNode > Considerations Expression of enter conditions that needs to evaluate true to allow the state to be selected.
Public variable UProperty Category, EditDefaultsOnly, Meta TArray< FStateTreeEditorNode > EnterConditions Expression of enter conditions that needs to evaluate true to allow the state to be selected.
Public variable UProperty Category, EditDefaultsOnly, Meta FGuid ID  
Public variable UProperty Category, EditDefaultsOnly TObjectPtr< UStateTree > LinkedAsset Another State Tree asset to run as extension of this State.
Public variable UProperty Category, EditDefaultsOnly, Meta FStateTreeStateLink LinkedSubtree Subtree to run as extension of this State.
Public variable UProperty Category, EditDefaultsOnly FName Name Display name of the State
Public variable UProperty Category, EditDefaultsOnly FStateTreeStateParameters Parameters Parameters of this state.
Public variable UProperty Meta TObjectPtr< UStateTreeState > Parent  
Public variable UProperty Category, EditDefaultsOnly, Meta FStateTreeEventDesc RequiredEventToEnter Defines the event required to be present during state selection for the state to be selected.
Public variable UProperty Category, EditDefaultsOnly EStateTreeStateSelectionBehavior SelectionBehavior How to treat child states when this State is selected.
Public variable UProperty Category, EditDefaultsOnly, Meta FStateTreeEditorNode SingleTask Single item used when schema calls for single task per state.
Public variable UProperty Category, EditDefaultsOnly FGameplayTag Tag GameplayTag describing the State
Public variable UProperty Category, EditDefaultsOnly, Meta TArray< FStateTreeEditorNode > Tasks  
Public variable UProperty Category, EditDefaultsOnly TArray< FStateTreeTransition > Transitions  
Public variable UProperty Category, EditDefaultsOnly EStateTreeStateType Type Type the State, allows e.g. states to be linked to other States.
Public variable UProperty Category, EditDefaultsOnly, Meta float Weight Weight used to scale the normalized final utility score for this state

Constructors

  Type Name Description
Public function  

UStateTreeState ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UStateTreeState &

AddChildState ( const FName ChildName,
const EStateTreeStateType StateType
)

 Adds child state with specified name.
Public function TStateTreeEditorNode< T > &

AddEnterCondition ( TArgs&&... InArgs
)

 Adds enter condition of specified type.
Public function TStateTreeEditorNode< T > &

AddTask ( TArgs&&... InArgs
)

 Adds Task of specified type.
Public function FStateTreeTransition &

AddTransition ( const EStateTreeTransitionTrigger InTrigger,
const EStateTreeTransitionType InType,
const UStateTreeState* InState
)

 Adds Transition.
Public function FStateTreeTransition &

AddTransition ( const EStateTreeTransitionTrigger InTrigger,
const FGameplayTag InEventTag,
const EStateTreeTransitionType InType,
const UStateTreeState* InState
)

  
Public function Const const FInstancedPropertyBag *  
Public function Const FGuid  
Public function Const FStateTreeStateLink StateTree Builder API.
Public function Const const UStateTreeState *  
Public function Const const UStateTreeState *  
Public function Const FString

GetPath ()

  
Public function Const const UStateTreeState *  
Public function Const bool

IsParametersPropertyOverridden ( const FGuid PropertyID
)

  
Public function void

OnTreeCompiled ( const UStateTree& StateTree
)

  
Public function void

SetLinkedStateAsset ( UStateTree* InLinkedAsset
)

 Sets linked asset and updates parameters to match the linked asset.
Public function void

SetParametersPropertyOverridden ( const FGuid PropertyID,
const bool bIsOverridden
)

 Sets the override status of specified property by ID.
Public function void  

Overridden from UObject

  Type Name Description
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FEditPropertyChain& PropertyAboutToChange
)

 This alternate version of PreEditChange is called when properties inside structs are modified.

Overridden from IStateTreeSchemaProvider

  Type Name Description
Public function Virtual Const TSubclassOf< UStateTreeSchema > IStateTreeSchemaProvider API.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page