1. Epic GamesDeveloper
  3. UStateTreeComponent

UStateTreeComponent

API > API/Plugins > API/Plugins/GameplayStateTreeModule > API/Plugins/GameplayStateTreeModule/Components

Inheritance Hierarchy

References

   
Module GameplayStateTreeModule
Header /Engine/Plugins/Runtime/GameplayStateTree/Source/GameplayStateTreeModule/Public/Components/StateTreeComponent.h
Include #include "Components/StateTreeComponent.h"

Syntax

UCLASS (ClassGroup=AI, HideCategories=(Activation, Collision), Meta=(BlueprintSpawnableComponent))  
class UStateTreeComponent :  
    public UBrainComponent,  
    public IGameplayTaskOwnerInterface ,  
    public IStateTreeSchemaProvider

Variables

  Type Name Description
Protected variable uint8: 1 bIsPaused If set, execution requests will be postponed
Protected variable uint8: 1 bIsRunning If set, state tree execution is allowed
Protected variable UProperty Category, EditAnywhere bool bStartLogicAutomatically If true, the StateTree logic is started on begin play.
Protected variable UProperty Transient FStateTreeInstanceData InstanceData  
Protected variable UProperty Category, EditAnywhere, Meta FStateTreeReferenceOverrides LinkedStateTreeOverrides Overrides for linked State Trees.
Public variable UProperty Category BlueprintAssignable FStateTreeRunStatusChanged OnStateTreeRunStatusChanged Called when the run status of the StateTree has changed
Protected variable UProperty Category, EditAnywhere, Meta FStateTreeReference StateTreeRef State Tree asset to run on the component.

Constructors

  Type Name Description
Public function  

UStateTreeComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void  
Public function Virtual void

Cleanup ()

  
Protected function Virtual Const bool  
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Public function Const UFunction BlueprintPure, Category EStateTreeRunStatus Returns the current run status of the StateTree.
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

PauseLogic ( const FString& Reason
)

  
Protected function Virtual void  
Public function Virtual void  
Public function Virtual EAILogicResuming::Type

ResumeLogic ( const FString& Reason
)

  
Public function UFunction BlueprintCallable, Category void Sends event to the running StateTree.
Public function void

SendStateTreeEvent ( const FGameplayTag Tag,
const FConstStructView Payload,
const FName Origin
)

 Sends event to the running StateTree.
Protected function Virtual bool

SetContextRequirements ( FStateTreeExecutionContext& Context,
bool bLogErrors
)

  
Public function UFunction BlueprintCallable, Category void

SetStartLogicAutomatically ( const bool bInStartLogicAutomatically
)

 Sets whether the State Tree is started automatically on being play.
Public function Virtual void  
Public function Virtual void

StopLogic ( const FString& Reason
)

  
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  
Public function Virtual void  

Overridden from IGameplayTaskOwnerInterface

  Type Name Description
Public function Virtual Const AActor * Get "body" of task's owner / default, having location in world (e.g. Owner = AIController, Avatar = Pawn)
Public function Virtual Const uint8 Get default priority for running a task
Public function Virtual Const AActor * Get owner of a task or default one when task is null
Public function Virtual Const UGameplayTasksComponent * Finds tasks component for given GameplayTask, Task.GetGameplayTasksComponent() may not be initialized at this point!
Public function Virtual void Notify called after GameplayTask finishes initialization (not active yet)

Overridden from IStateTreeSchemaProvider

  Type Name Description
Public function Virtual Const TSubclassOf< UStateTreeSchema >  

Deprecated Variables

  Type Name Description
Protected variable UProperty TObjectPtr< UStateTree > StateTree_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page