1. Epic GamesDeveloper
  3. FMassSmartObjectHandler

FMassSmartObjectHandler

Mediator struct that encapsulates communication between SmartObjectSubsystem and Mass.

API > API/Plugins > API/Plugins/MassSmartObjects

References

   
Module MassSmartObjects
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassSmartObjects/Public/MassSmartObjectHandler.h
Include #include "MassSmartObjectHandler.h"

Syntax

struct FMassSmartObjectHandler

Remarks

Mediator struct that encapsulates communication between SmartObjectSubsystem and Mass. This object is meant to be created and used in method scope to guarantee subsystems validity.

Constructors

  Type Name Description
Public function  

FMassSmartObjectHandler ( FMassEntityManager& InEntityManager,
FMassExecutionContext& InExecutionContext,
USmartObjectSubsystem& InSmartObjectSubsystem,
UMassSignalSubsystem& InSignalSubsystem
)

 FMassSmartObjectHandler constructor

Functions

  Type Name Description
Public function Const FSmartObjectClaimHandle Claims the first available smart object from the provided candidates.
Public function Const FSmartObjectClaimHandle Claims the first available slot holding any type of USmartObjectMassBehaviorDefinition in the smart object associated to the provided identifier.
Public function Const FMassSmartObjectRequestID

FindCandidatesAsync ( const FMassEntityHandle RequestingEntity,
const FGameplayTagContainer& UserTags,
const FGameplayTagQuery& ActivityRequirements,
const FVector& Location
)

 Creates an async request to build a list of compatible smart objects around the provided location.
Public function Const FMassSmartObjectRequestID

FindCandidatesAsync ( const FMassEntityHandle RequestingEntity,
const FGameplayTagContainer& UserTags,
const FGameplayTagQuery& ActivityRequirements,
const FZoneGraphCompactLaneLocation& LaneLocation
)

 Creates an async request to build a list of compatible smart objects around the provided lane location.
Public function Const const FMassSmartObjectCandidateSlots * Provides the result of a previously created request from FindCandidatesAsync to indicate if it has been processed and the results can be used by ClaimCandidate.
Public function Const void Releases a claimed/in-use smart object and update user fragment.
Public function Const void Deletes the request associated to the specified identifier
Public function Const bool Activates the mass gameplay behavior associated to the previously claimed smart object.
Public function Const void Deactivates the mass gameplay behavior started using StartUsingSmartObject.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page