Navigation
| Name | SmartObjectsModule |
| Type | Runtime |
| Part of Plugins | SmartObjects |
| Location | /Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/ |
| Module Build Rules | SmartObjectsModule.Build.cs |
Classes
| Name | Remarks |
|---|---|
| ADEPRECATED_SmartObjectCollection | Actor holding smart object persistent data |
| AGenericSmartObject | |
| ASmartObjectPersistentCollection | Actor holding smart object persistent data |
| FSmartObjectComponentEventSignature | |
| FSmartObjectDebugSceneProxy | Simple DebugRenderSceneProxy that gets relevant when associated component is shown and view flag is active (if specified on construction) |
| UBlackboardKeyType_SOClaimHandle | Blackboard key type that holds a SmartObject claim handle |
| UEnvQueryGenerator_SmartObjects | Fetches Smart Object slots within QueryBoxExtent from locations given by QueryOriginContext, that match SmartObjectRequestFilter |
| UEnvQueryItemType_SmartObject | |
| USmartObjectBehaviorDefinition | Abstract class that can be extended to bind a new type of behavior framework to the smart objects by defining the required definition. |
| USmartObjectBlueprintFunctionLibrary | |
| USmartObjectComponent | |
| USmartObjectContainerRenderingComponent | |
| USmartObjectDebugRenderingComponent | Simple UDebugDrawComponent to inherit from to use a FSmartObjectDebugSceneProxy. |
| USmartObjectDefinition | SmartObject definition asset. |
| USmartObjectHashGrid | |
| USmartObjectOctree | |
| USmartObjectRenderingComponent | |
| USmartObjectSettings | |
| USmartObjectSlotValidationFilter | Class used to define settings for Smart Object navigation and collision validation. |
| USmartObjectSpacePartition | Base class for space partitioning structure that can be used to store smart object locations |
| USmartObjectSubsystem | Subsystem that holds all registered smart object instances and offers the API for spatial queries and reservations. |
| USmartObjectUserComponent | Smart Object User Component defines common settings for a Smart Object user. |
| USmartObjectWorldConditionSchema | World Condition schema describing the data conditions and context data available for Smart Object conditions. |
Structs
| Name | Remarks |
|---|---|
| FConstSmartObjectSlotView | |
| FSmartObjectActorOwnerData | Struct that can be used to pass data related to the owner of a created SmartObject. |
| FSmartObjectActorUserData | Struct that can be used to pass data to the find or filtering methods. |
| FSmartObjectAnnotation_SlotUserCollision | Annotation to check if a smart object user can stand on the slot without overlaps. |
| FSmartObjectAnnotationCollider | Struct defining a collider in world space. |
| FSmartObjectAnnotationGameplayDebugContext | Context passed to CollectDataForGameplayDebugger to show gameplay debugger information. |
| FSmartObjectBindingCollection | Representation of all property bindings in a SmartObjectDefinition |
| FSmartObjectClaimHandle | Struct describing a reservation between a user and a smart object slot. |
| FSmartObjectCollectionEntry | Struct representing a unique registered component in the collection actor |
| FSmartObjectComponentInstanceData | Used to store SmartObjectComponent data during RerunConstructionScripts |
| FSmartObjectContainer | |
| FSmartObjectDefinitionBindableStructDescriptor | Descriptor for a struct or class that can be a binding source or target. |
| FSmartObjectDefinitionData | This is the base struct to inherit from to store custom definition data within the main slot definition |
| FSmartObjectDefinitionDataHandle | Used internally by USmartObjectDefinition to refer to a specific piece of data like the definition itself, its parameters struct, slot data, etc. |
| FSmartObjectDefinitionDataProxy | Helper struct for definition data, which allows to identify items based on GUID in editor (even empty ones). |
| FSmartObjectDefinitionPreviewData | Data used for previewing in the Smart Object editor. |
| FSmartObjectDefinitionPropertyBinding | Representation of a property binding used inside a FSmartObjectBindingCollection. |
| FSmartObjectDefinitionReference | Struct to hold reference to a SmartObjectDefinition asset along with values to parameterized it. |
| FSmartObjectEventData | Struct describing a change in Smart Object or Slot. |
| FSmartObjectHandle | Handle to a registered smartobject. |
| FSmartObjectHandleFactory | Struct used as a friend to FSmartObjectHandle that is the only caller allowed to create a handle from a Guid. |
| FSmartObjectHashGridEntryData | |
| FSmartObjectOctree | |
| FSmartObjectOctreeElement | |
| FSmartObjectOctreeEntryData | |
| FSmartObjectOctreeID | |
| FSmartObjectOctreeSemantics | |
| FSmartObjectRequest | Struct used to find a smart object within a specific search range and with optional filtering |
| FSmartObjectRequestFilter | Struct that can be used to filter results of a smart object request when trying to find or claim a smart object |
| FSmartObjectRequestResult | Struct that holds the object and slot selected by processing a smart object request. |
| FSmartObjectRuntime | Struct to store and manage state of a runtime instance associated to a given smart object definition |
| FSmartObjectRuntimeSlot | Struct to store and manage state of a runtime instance associated to a given slot definition |
| FSmartObjectSlotAnnotation | Base class for Smart Object Slot annotations. |
| FSmartObjectSlotDefinition | Persistent and sharable definition of a smart object slot. |
| FSmartObjectSlotEntranceAnnotation | Annotation to define a entrance locations for a Smart Object Slot. |
| FSmartObjectSlotEntranceHandle | Handle describing a specific entrance on a smart object slot. |
| FSmartObjectSlotEntranceLocationRequest | Struct used to request slot entry or exit location. |
| FSmartObjectSlotEntranceLocationResult | Validated result from FindEntranceLocationForSlot(). |
| FSmartObjectSlotEQSItem | |
| FSmartObjectSlotHandle | Struct used to identify a runtime slot instance |
| FSmartObjectSlotLinkAnnotation | Annotation to allow to find slots based on a Gameplay Tag. |
| FSmartObjectSlotReference | Helper struct to wrap basic functionalities to store the index of a slot in a SmartObject definition Reference to a specific Smart Object slot in a Smart Object Definition. |
| FSmartObjectSlotStateData | This is the base struct to inherit from to store custom state data associated to a slot |
| FSmartObjectSlotValidationParams | Parameters for Smart Object navigation and collision validation. |
| FSmartObjectSlotView | |
| FSmartObjectSpatialEntryData | This is the base struct to inherit from to store some data associated to a specific entry in the spatial representation structure |
| FSmartObjectTraceParams | Struct used to define how traces should be handled. |
| FSmartObjectUserCapsuleParams | Struct defining Smart Object user capsule size. |
| FSmartObjectUserHandle | Handle to a smartobject user. |
| FSmartObjectVisualizationContext | Helper class used for Smart Object Annotation rendering. |
| FSmartObjectWorldConditionBase | Base struct for all conditions accepted by Smart Objects. |
| FSmartObjectWorldConditionObjectTagQuery | |
| FSmartObjectWorldConditionObjectTagQueryState | World condition to match Smart Object's runtime tags. |
| FSmartObjectWorldConditionSlotTagQuery | |
| FSmartObjectWorldConditionSlotTagQueryState | World condition to match Smart Object slots's runtime tags. |
| FWorldCondition_SmartObjectActorTagQuery | World condition to match tags of the Smart Object's owning Actor (which must implement IGameplayTagAssetInterface or have an AbilitySystemComponent). |
| FWorldCondition_SmartObjectActorTagQueryState |
Interfaces
| Name | Remarks |
|---|---|
| ISmartObjectsModule | The public interface to this module |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGetAssetRegistryTags | TBaseDelegate_TwoParams< void, const USmartObjectDefinition &, FAssetRegistryTagsContext > | Delegate to retrieve Registry Tags for SmartObjectDefinition | SmartObjectDefinition.h |
| FOnMainCollectionEvent | TMulticastDelegate_NoParams< void > | Called when an event related to the main collection occured. | SmartObjectSubsystem.h |
| FOnParametersChanged | TMulticastDelegate_OneParam< void, const USmartObjectDefinition & > | Called in editor when parameters for a specific SmartObjectDefinition changes. | SmartObjectDefinition.h |
| FOnSavingDefinition | TMulticastDelegate_OneParam< void, const USmartObjectDefinition & > | Called in editor when a SmartObjectDefinition is about to be saved. | SmartObjectDefinition.h |
| FOnSlotDefinitionCreated | TBaseDelegate_TwoParams< void, USmartObjectDefinition &, FSmartObjectSlotDefinition & > | Called in editor when a new SmartObjectSlotDefinition is created (not called when duplicating an existing one). | SmartObjectDefinition.h |
| FOnSlotInvalidated | TBaseDelegate_TwoParams< void, const FSmartObjectClaimHandle &, ESmartObjectSlotState > | Runtime data holding the final slot transform (i.e. parent transform applied on slot local offset and rotation) Delegate to notify when a given slot gets invalidated and the interaction must be aborted | SmartObjectRuntime.h |
| FOnSmartObjectEvent | TMulticastDelegate_OneParam< void, const FSmartObjectEventData & > | Delegate called when Smart Object or Slot is changed. | SmartObjectTypes.h |
| FSmartObjectComponentEventNativeSignature | TMulticastDelegate_TwoParams< void, const FSmartObjectEventData &EventData, const AActor *Interactor > | SmartObjectComponent.h | |
| FSmartObjectHashGrid2D | THierarchicalHashGrid2D< 2, 4, FSmartObjectHandle > | SmartObjectHashGrid.h | |
| FSmartObjectOctreeIDSharedRef | TSharedRef< struct FSmartObjectOctreeID, ESPMode::ThreadSafe > | SmartObjectOctree.h | |
| FSmartObjectSlotNavigationLocationResult | FSmartObjectSlotEntranceLocationResult | SmartObjectSubsystem.h |
Enums
Public
| Name | Remarks |
|---|---|
| ESmartObjectChangeReason | Describes how Smart Object or slot was changed. |
| ESmartObjectClaimPriority | Enum indicating the claim priority of a Smart Object slot. |
| ESmartObjectCollectionRegistrationResult | Result code indicating if the Collection was successfully registered or why it was not. |
| ESmartObjectEntrancePriority | Enum used to define a entrance selection priority. |
| ESmartObjectPropertyPathRetargetingStatus | |
| ESmartObjectRegistrationType | |
| ESmartObjectSlotNavigationLocationType | Enum indicating if we're looking for a location to enter or exit the Smart Object slot. |
| ESmartObjectSlotShape | Indicates how Tags from slots and parent object are combined to be evaluated by a TagQuery from a find request. |
| ESmartObjectSlotState | Enumeration to represent the runtime state of a slot |
| ESmartObjectTagFilteringPolicy | Indicates how TagQueries from slots and parent object will be processed against Tags from a find request. |
| ESmartObjectTagMergingPolicy | Indicates how Tags from slots and parent object are combined to be evaluated by a TagQuery from a find request. |
| ESmartObjectTraceType | Indicates how TagQueries from slots and parent object will be processed against Tags from a find request. |
| ESmartObjectUnregistrationType | |
| ETrySpawnActorIfDehydrated | Indicates if the subsystem should try to spawn the actor associated to the smartobject if it is currently owned by an instanced actor. |
| FSmartObjectSlotEntrySelectionMethod | Defines method for selecting slot entry from multiple candidates. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| WithSmartObjectTag | const FName | SmartObjectTypes.h |