1. Epic GamesDeveloper
  3. UStateTreeState

UStateTreeState

Editor representation of a state in StateTree

API > API/Plugins > API/Plugins/StateTreeEditorModule

Editor representation of a state in StateTree

   
Name UStateTreeState
Type class
Header File /Engine/Plugins/Runtime/StateTree/Source/StateTreeEditorModule/Public/StateTreeState.h
Include Path #include "StateTreeState.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, EditInlineNew, CollapseCategories,  
       Meta=(DisallowLevelActorReference=true))  
class UStateTreeState :  
    public UObject ,  
    public IStateTreeSchemaProvider

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UStateTreeState ( const FObjectInitializer& ObjectInitializer
)

   StateTreeState.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UStateTreeState()

   StateTreeState.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCheckPrerequisitesWhenActivatingChildDirectly bool Should state's required event and enter conditions be evaluated when transition leads directly to it's child. StateTreeState.h
  • EditDefaultsOnly
  • Category="Enter Conditions"
bEnabled bool   StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
bExpanded bool   StateTreeState.h
  • Meta=(ExcludeFromHash)
bHasCustomTickRate bool Activate the CustomTickRate. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
  • Meta=(InlineEditConditionToggle)
bHasRequiredEventToEnter bool   StateTreeState.h
  • EditDefaultsOnly
  • Category="Enter Conditions"
  • Meta=(InlineEditConditionToggle)
Children TArray< TObjectPtr< UStateTreeState > >   StateTreeState.h
  • Instanced
ColorRef FStateTreeEditorColorRef Display color of the State StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
  • DisplayName="Color"
Considerations TArray< FStateTreeEditorNode > Expression of enter conditions that needs to evaluate true to allow the state to be selected. StateTreeState.h
  • EditDefaultsOnly
  • Category="Utility"
  • Meta=(BaseStruct="/Script/StateTreeModule.StateTreeConsiderationBase", BaseClass="/Script/StateTreeModule.StateTreeConsiderationBlueprintBase")
CustomTickRate float Tick rate in seconds the state tasks and transitions should tick. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
  • Meta=(EditCondition="bHasCustomTickRate", ClampMin=0.0f)
Description FString Description of the State StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
  • Meta=(MultiLine)
EnterConditions TArray< FStateTreeEditorNode > Expression of enter conditions that needs to evaluate true to allow the state to be selected. StateTreeState.h
  • EditDefaultsOnly
  • Category="Enter Conditions"
  • Meta=(BaseStruct="/Script/StateTreeModule.StateTreeConditionBase", BaseClass="/Script/StateTreeModule.StateTreeConditionBlueprintBase")
ID FGuid   StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
  • Meta=(IgnoreForMemberInitializationTest)
LinkedAsset TObjectPtr< UStateTree > Another State Tree asset to run as extension of this State. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
LinkedSubtree FStateTreeStateLink Subtree to run as extension of this State. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
  • Meta=(DirectStatesOnly, SubtreesOnly)
Name FName Display name of the State StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
Parameters FStateTreeStateParameters Parameters of this state. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
Parent TObjectPtr< UStateTreeState >   StateTreeState.h
  • Meta=(ExcludeFromHash)
RequiredEventToEnter FStateTreeEventDesc Defines the event required to be present during state selection for the state to be selected. StateTreeState.h
  • EditDefaultsOnly
  • Category="Enter Conditions"
  • Meta=(EditCondition="bHasRequiredEventToEnter")
SelectionBehavior EStateTreeStateSelectionBehavior How to treat child states when this State is selected. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
SingleTask FStateTreeEditorNode Single item used when schema calls for single task per state. StateTreeState.h
  • EditDefaultsOnly
  • Category="Task"
  • Meta=(BaseStruct="/Script/StateTreeModule.StateTreeTaskBase", BaseClass="/Script/StateTreeModule.StateTreeTaskBlueprintBase")
Tag FGameplayTag GameplayTag describing the State StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
Tasks TArray< FStateTreeEditorNode >   StateTreeState.h
  • EditDefaultsOnly
  • Category="Tasks"
  • Meta=(BaseStruct="/Script/StateTreeModule.StateTreeTaskBase", BaseClass="/Script/StateTreeModule.StateTreeTaskBlueprintBase")
TasksCompletion EStateTreeTaskCompletionType How tasks will complete the state. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
Transitions TArray< FStateTreeTransition >   StateTreeState.h
  • EditDefaultsOnly
  • Category="Transitions"
Type EStateTreeStateType Type the State, allows e.g. states to be linked to other States. StateTreeState.h
  • EditDefaultsOnly
  • Category="State"
Weight float Weight used to scale the normalized final utility score for this state StateTreeState.h
  • EditDefaultsOnly
  • Category="Utility"
  • Meta=(ClampMin=0)

Functions

Public

Name Remarks Include Path Unreal Specifiers

UStateTreeState & AddChildState ( const FName ChildName,
const EStateTreeStateType StateType
)

 Adds child state with specified name. StateTreeState.h  

TStateTreeEditorNode< T > & AddEnterCondition ( TArgs&&... InArgs
)

 Adds enter condition of specified type. StateTreeState.h  

TStateTreeEditorNode< T > & AddTask ( TArgs&&... InArgs
)

 Adds Task of specified type. StateTreeState.h  
Adds Transition. StateTreeState.h  

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

   StateTreeState.h  

const FInstancedPropertyBag * GetDefaultParameters()

   StateTreeState.h  

FGuid GetEventID()

   StateTreeState.h  

FStateTreeStateLink GetLinkToState()

   StateTreeState.h  

const UStateTreeState * GetNextSelectableSiblingState()

   StateTreeState.h  

const UStateTreeState * GetNextSiblingState()

   StateTreeState.h  

FString GetPath()

   StateTreeState.h  

const UStateTreeState * GetRootState()

   StateTreeState.h  

bool IsParametersPropertyOverridden ( const FGuid PropertyID
) const

   StateTreeState.h  

void OnTreeCompiled ( const UStateTree& StateTree
)

   StateTreeState.h  

void SetLinkedState ( FStateTreeStateLink InStateLink
)

 Sets linked state and updates parameters to match the linked state. StateTreeState.h  

void SetLinkedStateAsset ( UStateTree* InLinkedAsset
)

 Sets linked asset and updates parameters to match the linked asset. StateTreeState.h  

void SetParametersPropertyOverridden ( const FGuid PropertyID,
const bool bIsOverridden
)

 Sets the override status of specified property by ID. StateTreeState.h  

void UpdateParametersFromLinkedSubtree()

   StateTreeState.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   StateTreeState.h  

virtual void PostInitProperties()

   StateTreeState.h  

virtual void PostLoad()

   StateTreeState.h  

virtual void PreEditChange ( FEditPropertyChain& PropertyAboutToChange
)

   StateTreeState.h  

Overridden from IStateTreeSchemaProvider

Name Remarks Include Path Unreal Specifiers

virtual TSubclassOf< UStateTreeSchema > GetSchema()

   StateTreeState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page