Navigation
API > API/Plugins > API/Plugins/GameplayInteractionsModule
References
| Module | GameplayInteractionsModule |
| Header | /Engine/Plugins/Runtime/GameplayInteractions/Source/GameplayInteractionsModule/Public/GameplayInteractionContext.h |
| Include | #include "GameplayInteractionContext.h" |
Syntax
USTRUCT ()
struct FGameplayInteractionContext
Remarks
Struct that holds data required to perform the interaction and wraps StateTree execution
Variables
| Type | Name | Description | |
|---|---|---|---|
| FGameplayInteractionAbortContext | AbortContext | ||
| FSmartObjectClaimHandle | ClaimedHandle | ||
| TObjectPtr< AActor > | ContextActor | ||
| TObjectPtr< const UGameplayInteractionSmartObjectBehaviorDefinition > | Definition | ||
| EStateTreeRunStatus | LastRunStatus | ||
| FSmartObjectSlotEntranceHandle | SlotEntranceHandle | ||
| TObjectPtr< AActor > | SmartObjectActor | ||
| FStateTreeInstanceData | StateTreeInstanceData |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Activate
(
const UGameplayInteractionSmartObjectBehaviorDefinition& Definition |
Prepares the StateTree execution context using provided Definition then starts the underlying StateTree | |
| void | Deactivate () |
Stops the underlying StateTree | |
| const FSmartObjectClaimHandle & | |||
| EStateTreeRunStatus | |||
| bool | IsValid () |
||
| void | SendEvent
(
const FGameplayTag Tag, |
Sends event for the StateTree. Will be received on the next tick by the StateTree. | |
| void | SetAbortContext
(
const FGameplayInteractionAbortContext& InAbortContext |
||
| void | SetClaimedHandle
(
const FSmartObjectClaimHandle& InClaimedHandle |
||
| void | SetContextActor
(
AActor* InContextActor |
||
| bool | SetContextRequirements
(
FStateTreeExecutionContext& StateTreeContext |
Updates all external data views from the provided interaction context. | |
| void | SetSlotEntranceHandle
(
const FSmartObjectSlotEntranceHandle InSlotEntranceHandle |
||
| void | SetSmartObjectActor
(
AActor* InSmartObjectActor |
||
| bool | Tick
(
const float DeltaTime |
Updates the underlying StateTree | |
| bool | ValidateSchema
(
const FStateTreeExecutionContext& StateTreeContext |