1. Epic GamesDeveloper
  3. FGameplayInteractionContext

FGameplayInteractionContext

Struct that holds data required to perform the interaction and wraps StateTree execution

API > API/Plugins > API/Plugins/GameplayInteractionsModule

Struct that holds data required to perform the interaction and wraps StateTree execution

   
Name FGameplayInteractionContext
Type struct
Header File /Engine/Plugins/Runtime/GameplayInteractions/Source/GameplayInteractionsModule/Public/GameplayInteractionContext.h
Include Path #include "GameplayInteractionContext.h"

Syntax

USTRUCT ()  
struct FGameplayInteractionContext

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentlyRunningExecContext FStateTreeExecutionContext *   GameplayInteractionContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Activate ( const UGameplayInteractionSmartObjectBehaviorDefinition& Definition
)

 Prepares the StateTree execution context using provided Definition then starts the underlying StateTree GameplayInteractionContext.h  

void Deactivate()

 Stops the underlying StateTree GameplayInteractionContext.h  

const FSmartObjectClaimHandle & GetClaimedHandle()

   GameplayInteractionContext.h  

EStateTreeRunStatus GetLastRunStatus()

   GameplayInteractionContext.h  

bool IsValid()

   GameplayInteractionContext.h  

void SendEvent ( const FGameplayTag Tag,
const FConstStructView Payload,
const FName Origin
)

 Sends event for the StateTree. Will be received on the next tick by the StateTree. GameplayInteractionContext.h  

void SetAbortContext ( const FGameplayInteractionAbortContext& InAbortContext
)

   GameplayInteractionContext.h  

void SetClaimedHandle ( const FSmartObjectClaimHandle& InClaimedHandle
)

   GameplayInteractionContext.h  

void SetContextActor ( AActor* InContextActor
)

   GameplayInteractionContext.h  

void SetSlotEntranceHandle ( const FSmartObjectSlotEntranceHandle InSlotEntranceHandle
)

   GameplayInteractionContext.h  

void SetSmartObjectActor ( AActor* InSmartObjectActor
)

   GameplayInteractionContext.h  

bool Tick ( const float DeltaTime
)

 Updates the underlying StateTree GameplayInteractionContext.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool SetContextRequirements ( FStateTreeExecutionContext& StateTreeContext
)

 Updates all external data views from the provided interaction context. GameplayInteractionContext.h  

bool ValidateSchema ( const FStateTreeExecutionContext& StateTreeContext
) const

   GameplayInteractionContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page