Navigation
API > API/Plugins > API/Plugins/MassSmartObjects
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.
| Name | FMassSmartObjectHandler |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/MassGameplay/Source/MassSmartObjects/Public/MassSmartObjectHandler.h |
| Include Path | #include "MassSmartObjectHandler.h" |
Syntax
struct FMassSmartObjectHandler
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMassSmartObjectHandler
(
FMassExecutionContext& InExecutionContext, |
FMassSmartObjectHandler constructor | MassSmartObjectHandler.h | |
FMassSmartObjectHandler
(
FMassEntityManager& InEntityManager, |
MassSmartObjectHandler.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ExecutionContext | FMassExecutionContext & | MassSmartObjectHandler.h | ||
| SignalSubsystem | UMassSignalSubsystem & | MassSmartObjectHandler.h | ||
| SmartObjectSubsystem | USmartObjectSubsystem & | MassSmartObjectHandler.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSmartObjectClaimHandle ClaimCandidate
(
const FMassEntityHandle Entity, |
Claims the first available smart object from the provided candidates. | MassSmartObjectHandler.h | |
FSmartObjectClaimHandle ClaimSmartObject
(
const FMassEntityHandle Entity, |
Claims the first available slot holding any type of USmartObjectMassBehaviorDefinition in the smart object associated to the provided identifier. | MassSmartObjectHandler.h | |
FMassSmartObjectRequestID FindCandidatesAsync
(
const FMassEntityHandle RequestingEntity, |
Creates an async request to build a list of compatible smart objects around the provided location. | MassSmartObjectHandler.h | |
FMassSmartObjectRequestID FindCandidatesAsync
(
const FMassEntityHandle RequestingEntity, |
Creates an async request to build a list of compatible smart objects around the provided lane location. | MassSmartObjectHandler.h | |
const FMassSmartObjectCandidateSlots * GetRequestCandidates
(
const FMassSmartObjectRequestID& RequestID |
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. | MassSmartObjectHandler.h | |
void ReleaseSmartObject
(
const FMassEntityHandle Entity, |
Releases a claimed/in-use smart object and update user fragment. | MassSmartObjectHandler.h | |
void RemoveRequest
(
const FMassSmartObjectRequestID& RequestID |
Deletes the request associated to the specified identifier | MassSmartObjectHandler.h | |
bool StartUsingSmartObject
(
const FMassEntityHandle Entity, |
Activates the mass gameplay behavior associated to the previously claimed smart object. | MassSmartObjectHandler.h | |
void StopUsingSmartObject
(
const FMassEntityHandle Entity, |
Deactivates the mass gameplay behavior started using StartUsingSmartObject. | MassSmartObjectHandler.h |