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&40;ClassGroup&61;AI, HideCategories&61;&40;Activation, Collision&41;, Meta&61;&40;BlueprintSpawnableComponent&41;&41;  
class UStateTreeComponent :  
    public UBrainComponent,  
    public IGameplayTaskOwnerInterface

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  
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  

Constructors

  Type Name Description
Public function  

UStateTreeComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category EStateTreeRunStatus Returns the current run status of the StateTree.
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 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.

Overridden from UBrainComponent

  Type Name Description
Public function Virtual void

Cleanup ()

 AI logic won't be needed anymore, stop all activity and run cleanup
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

PauseLogic ( const FString& Reason
)

 Pause logic and blackboard updates.
Public function Virtual void Restarts currently running or previously ran brain logic.
Public function Virtual EAILogicResuming::Type

ResumeLogic ( const FString& Reason
)

 Resumes paused brain logic. MUST be called by child implementations!
Public function Virtual void Starts brain logic. If brain is already running, will not do anything.
Public function Virtual void

StopLogic ( const FString& Reason
)

 Stops currently running brain logic.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Begins Play for the component.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Public function Virtual void BEGIN UActorComponent overrides
Public function Virtual void

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

 Function called every frame on this ActorComponent.
Public function Virtual void Handle this component being Uninitialized.

Overridden from UObject

  Type Name Description
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

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)

Deprecated Variables

  Type Name Description
Protected variable UProperty TObjectPtr< UStateTree > StateTree_DEPRECATED This property has been deprecated. Use StateTreeReference instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page