1. Epic GamesDeveloper
  3. UGameplayBehavior

UGameplayBehavior

API > API/Plugins > API/Plugins/GameplayBehaviorsModule

   
Name UGameplayBehavior
Type class
Header File /Engine/Plugins/Experimental/GameplayBehaviors/Source/GameplayBehaviorsModule/Public/GameplayBehavior.h
Include Path #include "GameplayBehavior.h"

Syntax

UCLASS (MinimalAPI, Abstract, Blueprintable, BlueprintType)  
class UGameplayBehavior :  
    public UObject ,  
    public IGameplayTaskOwnerInterface

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UGameplayBehavior ( const FObjectInitializer& ObjectInitializer
)

   GameplayBehavior.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bFinishedCharacter uint32   GameplayBehavior.h  
bFinishedGeneric uint32   GameplayBehavior.h  
bFinishedPawn uint32   GameplayBehavior.h  
bTriggerCharacter uint32   GameplayBehavior.h  
bTriggerGeneric uint32   GameplayBehavior.h  
bTriggerPawn uint32   GameplayBehavior.h  
TransientProps uint32   GameplayBehavior.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTasks TArray< TObjectPtr< UGameplayTask > > List of currently active tasks, do not modify directly GameplayBehavior.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AbortBehavior ( AActor& Avatar
)

   GameplayBehavior.h  

virtual void EndBehavior ( AActor& Avatar,
const bool bInterrupted
)

   GameplayBehavior.h  

AActor * GetAvatar()

   GameplayBehavior.h  

virtual TOptional< FVector > GetDynamicLocation ( const AActor* InAvatar,
const UGameplayBehaviorConfig* InConfig,
const AActor* InSmartObjectOwner
) const

 Can return (it's optional) a dynamic location to use this gameplay behavior GameplayBehavior.h  

FOnGameplayBehaviorFinished & GetOnBehaviorFinishedDelegate()

   GameplayBehavior.h  

virtual UWorld * GetWorld()

   GameplayBehavior.h  

bool IsInstanced ( const UGameplayBehaviorConfig* Config
) const

 Returns true if this behavior instance is either a non-CDO object or is a CDO, but the class is intended to be used via its instances. GameplayBehavior.h  

void K2_AbortBehavior ( AActor* Avatar
)

   GameplayBehavior.h
  • BlueprintCallable
  • Category=GameplayBehavior
  • Meta=(DisplayName="AbortBehavior")

void K2_EndBehavior ( AActor* Avatar
)

   GameplayBehavior.h
  • BlueprintCallable
  • Category=GameplayBehavior
  • Meta=(DisplayName="EndBehavior")

int32 K2_GetNextActorIndexInSequence ( int32 CurrentIndex
) const

   GameplayBehavior.h
  • BlueprintCallable
  • Category=GameplayBehavior
  • Meta=(DisplayName="GetNextActorIndexInSequence")

void K2_OnFinished ( AActor* Avatar,
bool bWasInterrupted
)

   GameplayBehavior.h
  • BlueprintImplementableEvent
  • Category=GameplayBehavior
  • Meta=(AdvancedDisplay="TagPayload", DisplayName="OnFinished")

void K2_OnFinishedCharacter ( ACharacter* Avatar,
bool bWasInterrupted
)

   GameplayBehavior.h
  • BlueprintImplementableEvent
  • Category=GameplayBehavior
  • Meta=(AdvancedDisplay="TagPayload", DisplayName="OnFinishedCharacter")

void K2_OnFinishedPawn ( APawn* Avatar,
bool bWasInterrupted
)

   GameplayBehavior.h
  • BlueprintImplementableEvent
  • Category=GameplayBehavior
  • Meta=(AdvancedDisplay="TagPayload", DisplayName="OnFinishedPawn")

void K2_OnTriggered ( AActor* Avatar,
const UGameplayBehaviorConfig* Config,
AActor* SmartObjectOwner
)

 BP API. GameplayBehavior.h
  • BlueprintImplementableEvent
  • Category=GameplayBehavior
  • Meta=(AdvancedDisplay="TagPayload", DisplayName="OnTriggered")

void K2_OnTriggeredCharacter ( ACharacter* Avatar,
const UGameplayBehaviorConfig* Config,
AActor* SmartObjectOwner
)

   GameplayBehavior.h
  • BlueprintImplementableEvent
  • Category=GameplayBehavior
  • Meta=(AdvancedDisplay="TagPayload", DisplayName="OnTriggeredCharacter")

void K2_OnTriggeredPawn ( APawn* Avatar,
const UGameplayBehaviorConfig* Config,
AActor* SmartObjectOwner
)

   GameplayBehavior.h
  • BlueprintImplementableEvent
  • Category=GameplayBehavior
  • Meta=(AdvancedDisplay="TagPayload", DisplayName="OnTriggeredPawn")

void K2_TriggerBehavior ( AActor* Avatar,
UGameplayBehaviorConfig* Config,
AActor* SmartObjectOwner
)

   GameplayBehavior.h
  • BlueprintCallable
  • Category=GameplayBehavior
  • Meta=(DisplayName="TriggerBehavior")

void SetRelevantActors ( const TArray< AActor* >& InRelevantActors
)

   GameplayBehavior.h  

virtual bool Trigger ( AActor& Avatar,
const UGameplayBehaviorConfig* Config,
AActor* SmartObjectOwner
)

 Default implementation will trigger the appropriate Blueprint event based on their presence in the script and in the following priority: GameplayBehavior.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GameplayBehavior.h  

virtual void PostInitProperties()

   GameplayBehavior.h  

Overridden from IGameplayTaskOwnerInterface

Name Remarks Include Path Unreal Specifiers

virtual AActor * GetGameplayTaskAvatar ( const UGameplayTask* Task
) const

   GameplayBehavior.h  

virtual uint8 GetGameplayTaskDefaultPriority()

   GameplayBehavior.h  

virtual AActor * GetGameplayTaskOwner ( const UGameplayTask* Task
) const

   GameplayBehavior.h  

virtual UGameplayTasksComponent * GetGameplayTasksComponent ( const UGameplayTask& Task
) const

   GameplayBehavior.h  

virtual void OnGameplayTaskActivated ( UGameplayTask& Task
)

   GameplayBehavior.h  

virtual void OnGameplayTaskDeactivated ( UGameplayTask& Task
)

   GameplayBehavior.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool NeedsInstance ( const UGameplayBehaviorConfig* Config
) const

   GameplayBehavior.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page