1. Epic GamesDeveloper
  3. UStateTreeTaskBlueprintBase

UStateTreeTaskBlueprintBase

Base class for Blueprint based Tasks.

API > API/Plugins > API/Plugins/StateTreeModule

Base class for Blueprint based Tasks.

   
Name UStateTreeTaskBlueprintBase
Type class
Header File /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/Blueprint/StateTreeTaskBlueprintBase.h
Include Path #include "Blueprint/StateTreeTaskBlueprintBase.h"

Syntax

UCLASS (MinimalAPI, Abstract, Blueprintable)  
class UStateTreeTaskBlueprintBase : public UStateTreeNodeBlueprintBase

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UStateTreeTaskBlueprintBase ( const FObjectInitializer& ObjectInitializer
)

   Blueprint/StateTreeTaskBlueprintBase.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCanEditConsideredForCompletion uint8 True if the user can edit bConsideredForCompletion in the editor. Blueprint/StateTreeTaskBlueprintBase.h
  • EditDefaultsOnly
  • Category="Default"
bConsideredForCompletion uint8 True if the task is considered for completion. Blueprint/StateTreeTaskBlueprintBase.h
  • EditDefaultsOnly
  • Category="Default"

Functions

Public

Name Remarks Include Path Unreal Specifiers

EStateTreeRunStatus ReceiveEnterState ( const FStateTreeTransitionResult& Transition
)

   Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="EnterState (Deprecated)", DeprecatedFunction, DeprecationMessage="Use the new EnterState event without without return value instead. Task status is now controlled via FinishTask node, instead of a return value. Default status is running.")

void ReceiveExitState ( const FStateTreeTransitionResult& Transition
)

 Called when a current state is exited and task is part of active states. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="ExitState")
Called when a new state is entered and task is part of active states. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="EnterState")

void ReceiveLatentTick ( const float DeltaTime
)

 Called during state tree tick when the task is on active state. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="Tick")

void ReceiveStateCompleted ( const EStateTreeRunStatus CompletionStatus,
const FStateTreeActiveStates CompletedActiveStates
)

 Called right after a state has been completed, but before new state has been selected. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="StateCompleted")

EStateTreeRunStatus ReceiveTick ( const float DeltaTime
)

   Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="Tick (Deprecated)", DeprecatedFunction, DeprecationMessage="Use the new Tick event without without return value instead. Task status is now controlled via FinishTask node, instead of a return value. Default status is running.")

Protected

Name Remarks Include Path Unreal Specifiers

void BindDelegate ( const FStateTreeDelegateListener& Listener,
const FStateTreeDynamicDelegate& Delegate
)

 Registers the callback to the listener. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintCallable
  • Category="StateTree"
Broadcasts the dispatcher. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintCallable
  • Category="StateTree"

virtual EStateTreeRunStatus EnterState ( FStateTreeExecutionContext& Context,
const FStateTreeTransitionResult& Transition
)

   Blueprint/StateTreeTaskBlueprintBase.h  

virtual void ExitState ( FStateTreeExecutionContext& Context,
const FStateTreeTransitionResult& Transition
)

   Blueprint/StateTreeTaskBlueprintBase.h  

void FinishTask ( const bool bSucceeded
)

 Finish the task and sets it's status. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintCallable
  • Category="StateTree"
  • Meta=(HideSelfPin="true", DisplayName="Finish Task")

virtual void StateCompleted ( FStateTreeExecutionContext& Context,
const EStateTreeRunStatus CompletionStatus,
const FStateTreeActiveStates& CompletedActiveStates
)

   Blueprint/StateTreeTaskBlueprintBase.h  

virtual EStateTreeRunStatus Tick ( FStateTreeExecutionContext& Context,
const float DeltaTime
)

   Blueprint/StateTreeTaskBlueprintBase.h  

void UnbindDelegate ( const FStateTreeDelegateListener& Listener
)

 Unregisters the callback bound to the listener. Blueprint/StateTreeTaskBlueprintBase.h
  • BlueprintCallable
  • Category="StateTree"

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bHasEnterState_DEPRECATED uint8   Blueprint/StateTreeTaskBlueprintBase.h  
bHasTick_DEPRECATED uint8   Blueprint/StateTreeTaskBlueprintBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page