Navigation
| Name | MassSmartObjects |
| Type | Runtime |
| Part of Plugins | MassGameplay |
| Location | /Engine/Plugins/Runtime/MassGameplay/Source/MassSmartObjects/ |
| Module Build Rules | MassSmartObjects.Build.cs |
Classes
| Name | Remarks |
|---|---|
| UMassActiveSmartObjectDeinitializer | Signals entities with UE::Mass::Signals::SmartObjectActivationChanged when 'FMassInActiveSmartObjectsRangeTag' is removed. |
| UMassActiveSmartObjectInitializer | Signals entities with UE::Mass::Signals::SmartObjectActivationChanged when 'FMassInActiveSmartObjectsRangeTag' is added. |
| UMassActiveSmartObjectSignalProcessor | Signal based processor that creates and destroys the smart object instance associated to an entity based on valid FSmartObjectRegistration and FMassActorInstance fragments. |
| UMassActorInstanceHandleDeinitializer | Signals entities with UE::Mass::Signals::ActorInstanceHandleChanged when 'FMassActorInstanceFragment' is removed. |
| UMassActorInstanceHandleInitializer | Signals entities with UE::Mass::Signals::ActorInstanceHandleChanged when 'FMassActorInstanceFragment' is added. |
| UMassSmartObjectCandidatesFinderProcessor | Processor that builds a list of candidates objects for each users. |
| UMassSmartObjectDeinitializerBase | Processor that signals entities with FSmartObjectRegistration and FMassActorInstanceFragment fragments when the a given tag or fragment is removed from an entity. |
| UMassSmartObjectInitializerBase | Processor that signals entities with FSmartObjectRegistration and FMassActorInstanceFragment fragments when the a given tag or fragment is added to an entity. |
| UMassSmartObjectSettings | Settings for the MassSmartObject module. |
| UMassSmartObjectTimedBehaviorProcessor | Processor for time based user's behavior that waits x seconds then releases its claim on the object |
| UMassSmartObjectUserFragmentDeinitializer | Deinitializer processor to unregister slot invalidation callback when SmartObjectUser fragment gets removed |
| UMassSmartObjectUserTrait | Trait to allow an entity to interact with SmartObjects |
| USmartObjectMassBehaviorDefinition | Base class for MassAIBehavior definitions. |
| USmartObjectZoneAnnotations | ZoneGraph annotations for smart objects |
Structs
| Name | Remarks |
|---|---|
| FMassBehaviorEntityContext | Struct to pass around the required set of information to activate a mass behavior definition on a given entity. |
| FMassInActiveSmartObjectsRangeTag | Mass Tag applied on entities with FFSmartObjectRegistrationFragment that need to create smart objects |
| FMassSmartObjectCandidateSlots | Struct that holds status and results of a candidate finder request |
| FMassSmartObjectCompletedRequestTag | Special tag to mark processed requests |
| FMassSmartObjectHandler | Mediator struct that encapsulates communication between SmartObjectSubsystem and Mass. |
| FMassSmartObjectLaneLocationRequestFragment | Fragment used to build a list potential smart objects to use. |
| FMassSmartObjectRequestID | Identifier associated to a request for smart object candidates. |
| FMassSmartObjectRequestResultFragment | Fragment that holds the result of a request to find candidates. |
| FMassSmartObjectTimedBehaviorFragment | Fragment used to process time based smartobject interactions |
| FMassSmartObjectUserFragment | Fragment used by an entity to be able to interact with smart objects |
| FMassSmartObjectWorldLocationRequestFragment | Fragment used to build a list potential smart objects to use. |
| FSmartObjectAnnotationData | Per ZoneGraphData smart object look up data. |
| FSmartObjectCandidateSlot | Structure that represents a potential smart object slot for a MassEntity during the search |
| FSmartObjectLaneLocation | Struct to keep track of a SmartObject entry point on a given lane. |
| FSmartObjectLaneLocationIndices | Struct to store indices to all entry points on a given lane. |
| FSmartObjectMassEntityUserData | Struct that can be used to pass data to the find or filtering methods. |
| FSmartObjectRegistrationFragment | Mass Fragment storing the handle associated to the created smart object |
| FSmartObjectZoneAnnotationsInstanceData | Used to store data that is considered modified by the UCS and not generically saved during RerunConstructionScripts |
Interfaces
| Name | Remarks |
|---|---|
| IMassSmartObjectsModule | The public interface to this module. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAnnotationSettingsChanged | TMulticastDelegate_NoParams< void > | Called when annotation tag settings changed. | MassSmartObjectSettings.h |
Enums
Public
| Name | Remarks |
|---|---|
| EMassSmartObjectInteractionStatus |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SmartObjectCandidatesReady | const FName | MassSmartObjectTypes.h | ||
| SmartObjectInteractionAborted | const FName | MassSmartObjectTypes.h | ||
| SmartObjectInteractionDone | const FName | MassSmartObjectTypes.h | ||
| SmartObjectRequestCandidates | const FName | MassSmartObjectTypes.h |