1. Epic GamesDeveloper
  3. USmartObjectSubsystem

USmartObjectSubsystem

Subsystem that holds all registered smart object instances and offers the API for spatial queries and reservations.

API > API/Plugins > API/Plugins/SmartObjectsModule

Subsystem that holds all registered smart object instances and offers the API for spatial queries and reservations.

[Notes regarding thread safety] The subsystem is not thread-safe, but a first pass has been made to make it possible to perform a set of operations from multiple threads. To use this mode the following compiler switch is required: #define WITH_SMARTOBJECT_MT_INSTANCE_LOCK 1

Not safe:

  • runtime instance lifetime controlled from Registration/Unregistration (i.e., CreateSmartObject, RegisterCollection, UnregisterCollection, DestroySmartObject, etc.)
  • queries: to prevent locking for a long time it is still required to send queries from a single thread (e.g., async request pattern like MassSmartObject)

Safe operation on a smart object instance or slot from an object or slot handle:

  • query and set Enable state
  • query and set Transform/Location
  • query and set Tags
  • update slot state (e.g., MarkSlotAsClaimed, MarkSlotAsReleased, etc.)
  • use a slot view using ReadSlotData/MutateSlotData
   
Name USmartObjectSubsystem
Type class
Header File /Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/Public/SmartObjectSubsystem.h
Include Path #include "SmartObjectSubsystem.h"

Syntax

UCLASS (MinimalAPI, Config=SmartObjects, defaultconfig, Transient)  
class USmartObjectSubsystem : public UWorldSubsystem

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

USmartObjectSubsystem()

   SmartObjectSubsystem.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnMainCollectionChanged FOnMainCollectionEvent   SmartObjectSubsystem.h  
OnMainCollectionDirtied FOnMainCollectionEvent   SmartObjectSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddSlotData ( const FSmartObjectClaimHandle& ClaimHandle,
FConstStructView InData
)

 Adds state data to a slot instance. SmartObjectSubsystem.h  

void AddTagToInstance ( const FSmartObjectHandle Handle,
const FGameplayTag& Tag
)

 Adds a single tag to the smart object instance represented by the provided handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

void AddTagToSlot ( const FSmartObjectSlotHandle SlotHandle,
const FGameplayTag& Tag
)

 Adds a single tag to the smart object slot represented by the provided handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

void BindComponentToSimulation ( USmartObjectComponent& SmartObjectComponent
)

 Binds a smart object component to an existing instance in the simulation. SmartObjectSubsystem.h  

bool CanBeClaimed ( const FSmartObjectSlotHandle& SlotHandle,
ESmartObjectClaimPriority ClaimPriority
) const

 Checks whether given slot is free and can be claimed (i.e. slot and its parent are both enabled) SmartObjectSubsystem.h  

FSmartObjectHandle CreateSmartObject ( const USmartObjectDefinition& Definition,
const FTransform& Transform,
const FConstStructView OwnerData
)

 Creates a new smart object runtime instance from an external system. SmartObjectSubsystem.h  

void DebugCleanupRuntime()

 Debugging helper to emulate the stop of the simulation to destroy all runtime data SmartObjectSubsystem.h  

void DebugDraw ( FDebugRenderSceneProxy* DebugProxy
) const

   SmartObjectSubsystem.h  

void DebugDrawCanvas ( UCanvas* Canvas,
APlayerController* PlayerController
) const

   SmartObjectSubsystem.h  

uint32 DebugGetNumRegisteredComponents()

   SmartObjectSubsystem.h  

uint32 DebugGetNumRuntimeObjects()

   SmartObjectSubsystem.h  

const TMap< FSmartObjectHandle, FSmartObjectRuntime > & DebugGetRuntimeObjects()

   SmartObjectSubsystem.h  

void DebugInitializeRuntime()

 Debugging helper to emulate the start of the simulation to create all runtime data SmartObjectSubsystem.h  

void DebugRegisterAllSmartObjects()

 Debugging helpers to add all registered smart objects to the simulation SmartObjectSubsystem.h  

void DebugUnregisterAllSmartObjects()

 Debugging helper to remove all registered smart objects from the simulation SmartObjectSubsystem.h  

bool DestroySmartObject ( FSmartObjectHandle Handle
)

 Removes the smart object runtime data from the simulation, destroys it and unbinds and unregister associated component if any. SmartObjectSubsystem.h  

bool EvaluateSelectionConditions ( const FSmartObjectSlotHandle& SlotHandle,
const FConstStructView UserData
) const

 Evaluates conditions of the specified slot and its parent smart object. SmartObjectSubsystem.h  

TArray< FSmartObjectRequestResult > FilterResultsBySelectionConditions ( const TConstArrayView< FSmartObjectRequestResult >& ResultsToFilter,
const FConstStructView UserData
) const

 Evaluates conditions of the slot specified by each request result and add to the result array on success. SmartObjectSubsystem.h  

TArray< FSmartObjectSlotHandle > FilterSlotsBySelectionConditions ( const TConstArrayView< FSmartObjectSlotHandle >& SlotsToFilter,
const FConstStructView UserData
) const

 Evaluates conditions of each slot and add to the result array on success. SmartObjectSubsystem.h  
Finds entrance location for a specific slot. SmartObjectSubsystem.h  

void FindSlots ( const FSmartObjectHandle Handle,
const FSmartObjectRequestFilter& Filter,
TArray< FSmartObjectSlotHandle >& OutSlots,
const FConstStructView UserData
) const

 Returns slots of a given smart object matching the filter. SmartObjectSubsystem.h  
Spatial lookup for first slot in range respecting request criteria and selection conditions. SmartObjectSubsystem.h  

FSmartObjectRequestResult FindSmartObject ( const FSmartObjectRequest& Request,
const AActor* UserActor
) const

 Spatial lookup for first slot in range respecting request criteria and selection conditions. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

bool FindSmartObjects ( const FSmartObjectRequest& Request,
TArray< FSmartObjectRequestResult >& OutResults,
const FConstStructView UserData
) const

 Spatial lookup for slot candidates respecting request criteria and selection conditions. SmartObjectSubsystem.h  

bool FindSmartObjects ( const FSmartObjectRequest& Request,
TArray< FSmartObjectRequestResult >& OutResults,
const AActor* UserActor
) const

 DEPRECATED BLOCK BEGIN SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Find Smart Objects (Pure)", DeprecatedFunction, DeprecationMessage="The pure version is deprecated, place a new Find Smart Objects node and connect the exec pin")

bool FindSmartObjects_BP ( const FSmartObjectRequest& Request,
TArray< FSmartObjectRequestResult >& OutResults,
const AActor* UserActor
) const

 Blueprint function for spatial lookup for slot candidates respecting request criteria and selection conditions. SmartObjectSubsystem.h
  • BlueprintCallable
  • BlueprintPure=False
  • Category="SmartObject"
  • Meta=(DisplayName="Find Smart Objects")

bool FindSmartObjectsInList ( const FSmartObjectRequestFilter& Filter,
const TConstArrayView< AActor* > ActorList,
TArray< FSmartObjectRequestResult >& OutResults,
const FConstStructView UserData
) const

 Search list of specific actors (often from a physics query) for slot candidates respecting request criteria and selection conditions. SmartObjectSubsystem.h  

bool FindSmartObjectsInTargetingRequest ( const FSmartObjectRequestFilter& Filter,
const FTargetingRequestHandle TargetingHandle,
TArray< FSmartObjectRequestResult >& OutResults,
const FConstStructView UserData
) const

 Search the results of the given targeting request handle for smart objects that match the request criteria SmartObjectSubsystem.h  

void GetAllSlots ( const FSmartObjectHandle Handle,
TArray< FSmartObjectSlotHandle >& OutSlots
) const

 Return all slots of a given smart object. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

const DefinitionType * GetBehaviorDefinition ( const FSmartObjectClaimHandle& ClaimHandle
)

 Return the behavior definition of a given type from a claimed object. SmartObjectSubsystem.h  

const DefinitionType * GetBehaviorDefinition ( const FSmartObjectRequestResult& RequestResult
)

 Return the behavior definition of a given type from a claimed object. SmartObjectSubsystem.h  
Return the behavior definition of a given type from a claimed object. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DeterminesOutputType="DefinitionClass")

const USmartObjectBehaviorDefinition * GetBehaviorDefinitionByRequestResult ( const FSmartObjectRequestResult& RequestResult,
TSubclassOf< USmartObjectBehaviorDefinition > DefinitionClass
)

 Return the behavior definition of a given type from a request result. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DeterminesOutputType="DefinitionClass")

FOnSmartObjectEvent * GetEventDelegate ( const FSmartObjectHandle SmartObjectHandle
)

 Returns pointer to the smart object instance event delegate. SmartObjectSubsystem.h  

const FGameplayTagContainer & GetInstanceTags ( const FSmartObjectHandle Handle
) const

 Returns the list of tags associated to the smart object instance represented by the provided handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

TArrayView< TWeakObjectPtr< ASmartObjectPersistentCollection > > GetMutableRegisteredCollections()

   SmartObjectSubsystem.h  

FSmartObjectContainer & GetMutableSmartObjectContainer()

   SmartObjectSubsystem.h  
Returns a view on the owner data for the smart object instance represented by the provided handle. SmartObjectSubsystem.h  

TConstArrayView< TWeakObjectPtr< ASmartObjectPersistentCollection > > GetRegisteredCollections()

   SmartObjectSubsystem.h  

FOnSmartObjectEvent * GetSlotEventDelegate ( const FSmartObjectSlotHandle& SlotHandle
)

 Returns pointer to the smart object changed delegate associated to the provided handle. SmartObjectSubsystem.h  

TOptional< FVector > GetSlotLocation ( const FSmartObjectClaimHandle& ClaimHandle
) const

 Returns the position (in world space) of the slot associated to the given claim handle. SmartObjectSubsystem.h  

TOptional< FVector > GetSlotLocation ( const FSmartObjectRequestResult& Result
) const

 Returns the position (in world space) of the slot associated to the given request result. SmartObjectSubsystem.h  

TOptional< FVector > GetSlotLocation ( const FSmartObjectSlotHandle& SlotHandle
) const

 Returns the position (in world space) of the slot represented by the provided slot handle. SmartObjectSubsystem.h  

bool GetSlotLocation ( const FSmartObjectClaimHandle& ClaimHandle,
FVector& OutSlotLocation
) const

 Returns the position (in world space) of the slot associated to the given claim handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

ESmartObjectSlotState GetSlotState ( const FSmartObjectSlotHandle SlotHandle
) const

 Returns the state of the given smart object Slot handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"

const FGameplayTagContainer & GetSlotTags ( const FSmartObjectSlotHandle SlotHandle
) const

 Returns the list of tags associated to the smart object slot represented by the provided handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

TOptional< FTransform > GetSlotTransform ( const FSmartObjectRequestResult& Result
) const

 Returns the transform (in world space) of the slot associated to the given request result. SmartObjectSubsystem.h  

TOptional< FTransform > GetSlotTransform ( const FSmartObjectSlotHandle& SlotHandle
) const

 Returns the transform (in world space) of the slot represented by the provided slot handle. SmartObjectSubsystem.h  

bool GetSlotTransform ( const FSmartObjectClaimHandle& ClaimHandle,
FTransform& OutSlotTransform
) const

 Returns the transform (in world space) of the slot associated to the given claim handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

TOptional< FTransform > GetSlotTransform ( const FSmartObjectClaimHandle& ClaimHandle
) const

 Returns the transform (in world space) of the slot associated to the given claim handle. SmartObjectSubsystem.h  

FTransform GetSlotTransformChecked ( const FSmartObjectSlotHandle& SlotHandle
) const

 Similarly to GetSlotTransform fetches the transform (in world space) of the indicated slot, but assumes the slot handle is valid and that the EntityManager is known. SmartObjectSubsystem.h  

bool GetSlotTransformFromRequestResult ( const FSmartObjectRequestResult& RequestResult,
FTransform& OutSlotTransform
) const

 Returns the transform (in world space) of the slot associated to the given RequestResult. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

FSmartObjectSlotView GetSlotView ( const FSmartObjectSlotHandle& SlotHandle
) const

   SmartObjectSubsystem.h  

USmartObjectComponent * GetSmartObjectComponent ( const FSmartObjectClaimHandle& ClaimHandle,
ETrySpawnActorIfDehydrated TrySpawnActorIfDehydrated
) const

 Returns the component associated to the claim handle if still accessible. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

USmartObjectComponent * GetSmartObjectComponentByRequestResult ( const FSmartObjectRequestResult& Result,
ETrySpawnActorIfDehydrated TrySpawnActorIfDehydrated
) const

 Returns the component associated to the given request result In some scenarios the component may no longer exist but its smart object data could (e.g. streaming) SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

const FSmartObjectContainer & GetSmartObjectContainer()

   SmartObjectSubsystem.h  

bool IsClaimedSmartObjectValid ( const FSmartObjectClaimHandle& ClaimHandle
) const

 Indicates if the object/slot referred to by the given handle are still accessible in the simulation. SmartObjectSubsystem.h  

bool IsEnabled ( const FSmartObjectHandle Handle
) const

 Returns the enabled state of the smart object represented by the provided handle regardless of the disabled reason. SmartObjectSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"
  • Meta=(DisplayName="Is SmartObject Enabled (for any reason)", ReturnDisplayName="Enabled")

bool IsEnabledForReason ( const FSmartObjectHandle Handle,
FGameplayTag ReasonTag
) const

 Returns the enabled state of the smart object represented by the provided handle based on a specific reason. SmartObjectSubsystem.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"
  • Meta=(DisplayName="Is SmartObject Enabled (for specific reason)", ReturnDisplayName="Enabled")

bool IsSmartObjectSlotValid ( const FSmartObjectSlotHandle& SlotHandle
) const

 Indicates if the slot referred to by the given handle is still accessible in the simulation. SmartObjectSubsystem.h  

bool IsSmartObjectValid ( const FSmartObjectHandle Handle
) const

 Indicates if the object referred to by the given handle is still accessible in the simulation. SmartObjectSubsystem.h  

FSmartObjectClaimHandle MarkSlotAsClaimed ( const FSmartObjectSlotHandle& SlotHandle,
ESmartObjectClaimPriority ClaimPriority,
const FConstStructView UserData
)

 Marks a smart object slot as claimed. SmartObjectSubsystem.h  

bool MarkSlotAsFree ( const FSmartObjectClaimHandle& ClaimHandle
)

 Marks a claimed or occupied smart object as free. SmartObjectSubsystem.h  
Marks a previously claimed smart object slot as occupied. SmartObjectSubsystem.h  

const DefinitionType * MarkSlotAsOccupied ( const FSmartObjectClaimHandle& ClaimHandle
)

 Marks a previously claimed smart object slot as occupied. SmartObjectSubsystem.h  

bool MutateSlotData ( const FSmartObjectSlotHandle& SlotHandle,
TFunctionRef< void(const FSmartObjectSlotView&)> Function
) const

 Executes the provided function if a valid mutable view can be created for the provided slot handle. SmartObjectSubsystem.h  

bool ReadSlotData ( const FSmartObjectSlotHandle& SlotHandle,
TFunctionRef< void(FConstSmartObjectSlotView)> Function
) const

 Executes the provided function if a valid const view can be created for the provided slot handle. SmartObjectSubsystem.h  
  SmartObjectSubsystem.h  

void RegisterSlotInvalidationCallback ( const FSmartObjectClaimHandle& ClaimHandle,
const FOnSlotInvalidated& Callback
)

 Register a callback to be notified if the claimed slot is no longer available and user need to perform cleanup. SmartObjectSubsystem.h  

bool RegisterSmartObject ( TNotNull< USmartObjectComponent* > SmartObjectComponent
)

 Registers a smart object components to the runtime simulation. SmartObjectSubsystem.h  

bool RegisterSmartObject ( USmartObjectComponent& SmartObjectComponent
)

   SmartObjectSubsystem.h  

bool RegisterSmartObjectActor ( const AActor& SmartObjectActor
)

 Registers to the runtime simulation all smart object components for a given actor. SmartObjectSubsystem.h  

bool Release ( const FSmartObjectClaimHandle& ClaimHandle
)

   SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use MarkSmartObjectSlotAsFree instead.")

bool RemoveSmartObject ( USmartObjectComponent& SmartObjectComponent
)

   SmartObjectSubsystem.h  

bool RemoveSmartObject ( TNotNull< USmartObjectComponent* > SmartObjectComponent
)

 Unregisters the component from the subsystem, unbinds it from the runtime simulation and removes its runtime data. SmartObjectSubsystem.h  

bool RemoveSmartObjectActor ( const AActor& SmartObjectActor
)

 Removes all data associated to smart object components of a given actor from the simulation. SmartObjectSubsystem.h  

void RemoveTagFromInstance ( const FSmartObjectHandle Handle,
const FGameplayTag& Tag
)

 Removes a single tag from the smart object instance represented by the provided handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

bool RemoveTagFromSlot ( const FSmartObjectSlotHandle SlotHandle,
const FGameplayTag& Tag
)

 Removes a single tag from the smart object slot represented by the provided handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

bool SendSlotEvent ( const FSmartObjectSlotHandle& SlotHandle,
const FGameplayTag EventTag,
const FConstStructView Payload
)

 Sends event to a smart object slot. SmartObjectSubsystem.h  

bool SetEnabled ( const FSmartObjectHandle Handle,
const bool bEnabled
)

 Enables or disables the entire smart object represented by the provided handle using the default reason (i.e. Gameplay).. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Set SmartObject Enabled (default reason: Gameplay)", ReturnDisplayName="Status changed")

bool SetEnabledForReason ( const FSmartObjectHandle Handle,
FGameplayTag ReasonTag,
const bool bEnabled
)

 Enables or disables the entire smart object represented by the provided handle using the specified reason. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Set SmartObject Enabled (specific reason)", ReturnDisplayName="Status changed")

bool SetSlotEnabled ( const FSmartObjectSlotHandle SlotHandle,
const bool bEnabled
)

 Enables or disables the smart object slot represented by the provided handle. SmartObjectSubsystem.h
  • BlueprintCallable
  • Category="SmartObject"

bool SetSmartObjectActorEnabled ( const AActor& SmartObjectActor,
bool bEnabled
)

 Enables or disables all smart objects associated to the provided actor (multiple components). SmartObjectSubsystem.h  

void UnbindComponentFromSimulation ( USmartObjectComponent& SmartObjectComponent
)

 Unbinds a smart object component from an existing instance in the simulation. SmartObjectSubsystem.h  

void UnregisterCollection ( ASmartObjectPersistentCollection& InCollection
)

   SmartObjectSubsystem.h  

void UnregisterSlotInvalidationCallback ( const FSmartObjectClaimHandle& ClaimHandle
)

 Unregisters a callback to be notified if the claimed slot is no longer available and user need to perform cleanup. SmartObjectSubsystem.h  

bool UnregisterSmartObject ( USmartObjectComponent& SmartObjectComponent
)

   SmartObjectSubsystem.h  

bool UnregisterSmartObject ( TNotNull< USmartObjectComponent* > SmartObjectComponent
)

 Unregisters the component from the subsystem, unbinds it from the runtime simulation and handles the associated runtime data according to the component registration type (i.e. runtime data associated to components from persistent collections will remain in the simulation). SmartObjectSubsystem.h  

bool UnregisterSmartObjectActor ( const AActor& SmartObjectActor
)

 Unregisters from the simulation all smart object components for a given actor. SmartObjectSubsystem.h  
Runs the same logic as FindEntranceLocationForSlot() but for a specific entrance location. SmartObjectSubsystem.h  

bool UpdateSmartObjectTransform ( const FSmartObjectHandle Handle,
const FTransform& NewTransform
)

 Updates the smart object transform. SmartObjectSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AbortAll ( const FSmartObjectHandle Handle,
FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

void AbortAllInternal ( const FSmartObjectHandle Handle,
FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

bool ActivateObjectPreconditions ( const FWorldConditionContextData& ContextData,
const FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

bool ActivateObjectPreconditionsInternal ( const FWorldConditionContextData& ContextData,
const FSmartObjectRuntime& SmartObjectRuntime
) const

 Activate preconditions on the main object. SmartObjectSubsystem.h  

bool ActivateSlotPreconditions ( FWorldConditionContextData& ContextData,
const FSmartObjectRuntimeSlot& Slot,
FSmartObjectSlotHandle SlotHandle
) const

   SmartObjectSubsystem.h  

bool ActivateSlotPreconditionsInternal ( FWorldConditionContextData& ContextData,
const FSmartObjectRuntimeSlot& Slot,
const FSmartObjectSlotHandle& SlotHandle
) const

 Activate preconditions on the specified slot. SmartObjectSubsystem.h  

FSmartObjectRuntime * AddCollectionEntryToSimulation ( const FSmartObjectCollectionEntry& Entry,
const USmartObjectDefinition& Definition,
USmartObjectComponent* OwnerComponent
)

   SmartObjectSubsystem.h  

FSmartObjectRuntime * AddCollectionEntryToSimulationInternal ( const FSmartObjectCollectionEntry& Entry,
const USmartObjectDefinition& Definition,
USmartObjectComponent* OwnerComponent
)

 Registers a collection entry to the simulation and creates its associated runtime instance. SmartObjectSubsystem.h  

FSmartObjectRuntime * AddComponentToSimulation ( USmartObjectComponent& SmartObjectComponent,
const FSmartObjectCollectionEntry& CollectionEntry
)

   SmartObjectSubsystem.h  

FSmartObjectRuntime * AddComponentToSimulationInternal ( TNotNull< USmartObjectComponent* > SmartObjectComponent,
const FSmartObjectCollectionEntry& CollectionEntry
)

 Registers a collection entry to the simulation and creates its associated runtime instance. SmartObjectSubsystem.h  

void AddContainerToSimulation ( const FSmartObjectContainer& InSmartObjectContainer
)

   SmartObjectSubsystem.h  

void BindComponentToSimulationInternal ( TNotNull< USmartObjectComponent* > SmartObjectComponent,
FSmartObjectRuntime& SmartObjectRuntime
) const

 Binds a smart object component to an existing instance in the simulation and notifies that it has been bound. SmartObjectSubsystem.h  

void BindComponentToSimulationInternal ( USmartObjectComponent& SmartObjectComponent,
FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

void BindPropertiesFromStruct ( FWorldConditionContextData& ContextData,
const FConstStructView& UserData
) const

   SmartObjectSubsystem.h  

void BindPropertiesFromStructInternal ( FWorldConditionContextData& ContextData,
const FConstStructView& UserData
) const

 Binds properties of the context data to property values of the user data struct when they match type and name. SmartObjectSubsystem.h  

virtual void CleanupRuntime()

 Removes all runtime data SmartObjectSubsystem.h  

FBox ComputeBounds ( const UWorld& World
) const

 Compute bounds from the given world SmartObjectSubsystem.h  

FSmartObjectRuntime * CreateRuntimeInstance ( const FSmartObjectHandle Handle,
const USmartObjectDefinition& Definition,
const FBox& Bounds,
USmartObjectComponent* OwnerComponent
)

 Initializes preconditions, adds to the space partition structure using the specified bounds and broadcasts event. SmartObjectSubsystem.h  

void DestroyRuntimeInstanceInternal ( const FSmartObjectHandle Handle,
FSmartObjectRuntime& SmartObjectRuntime
)

 Destroy SmartObjectRuntime contents as Handle's representation. SmartObjectSubsystem.h  

bool EvaluateConditionsForFiltering ( const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectSlotHandle SlotHandle,
FWorldConditionContextData& ContextData,
const FConstStructView UserData,
TPair< const FSmartObjectRuntime*, bool >& LastEvaluatedRuntime
) const

   SmartObjectSubsystem.h  

bool EvaluateConditionsForFilteringInternal ( const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectSlotHandle& SlotHandle,
FWorldConditionContextData& ContextData,
const FConstStructView UserData,
TPair< const FSmartObjectRuntime*, bool >& LastEvaluatedRuntime
) const

 Internal helper for filter methods to build the list of accepted slots by reusing context data and schema as much as possible. SmartObjectSubsystem.h  

bool EvaluateObjectConditions ( const FWorldConditionContextData& ConditionContextData,
const FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

bool EvaluateObjectConditionsInternal ( const FWorldConditionContextData& ConditionContextData,
const FSmartObjectRuntime& SmartObjectRuntime
) const

 Use the provided context data that is expected to be already filled by calling 'SetupConditionContextCommonData' and evaluates all conditions associated to the specified object. SmartObjectSubsystem.h  

bool EvaluateSlotConditions ( FWorldConditionContextData& ConditionContextData,
const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectSlotHandle SlotHandle
) const

   SmartObjectSubsystem.h  

bool EvaluateSlotConditionsInternal ( FWorldConditionContextData& ConditionContextData,
const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectSlotHandle& SlotHandle
) const

 Use the provided context data that is expected to be already filled by calling 'SetupConditionContextCommonData' and adds the slot related part. SmartObjectSubsystem.h  

void ExecuteOnSlotFilteredBySelectionConditions ( const TConstStridedView< FSmartObjectSlotHandle > SlotsToFilter,
const FConstStructView UserData,
TFunctionRef< void(const int32)> Function
) const

   SmartObjectSubsystem.h  

bool ExecuteOnValidatedMutableRuntime ( const FSmartObjectHandle SlotHandle,
TFunctionRef< void(FSmartObjectRuntime&)> Function,
const ANSICHAR* CallingFunctionName
) const

 Executes the provided function using the runtime instance associated to the provided handle. SmartObjectSubsystem.h  

bool ExecuteOnValidatedMutableRuntimeAndSlot ( const FSmartObjectSlotHandle& SlotHandle,
TFunctionRef< void(FSmartObjectRuntime&, FSmartObjectRuntimeSlot&)> Function,
const ANSICHAR* CallingFunctionName
) const

 Executes the provided function using the runtime instance associated to the provided handle. SmartObjectSubsystem.h  

bool ExecuteOnValidatedRuntime ( const FSmartObjectHandle SlotHandle,
TFunctionRef< void(const FSmartObjectRuntime&)> Function,
const ANSICHAR* CallingFunctionName
) const

 Executes the provided function using the runtime instance associated to the provided handle. SmartObjectSubsystem.h  

bool ExecuteOnValidatedRuntimeAndSlot ( const FSmartObjectSlotHandle& SlotHandle,
TFunctionRef< void(const FSmartObjectRuntime&, const FSmartObjectRuntimeSlot&)> Function,
const ANSICHAR* CallingFunctionName
) const

 Executes the provided function using the runtime instance associated to the provided handle. SmartObjectSubsystem.h  
Finds entrance location for a specific slot. SmartObjectSubsystem.h  

void FindSlots ( const FSmartObjectHandle Handle,
const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectRequestFilter& Filter,
TArray< FSmartObjectSlotHandle >& OutResults,
const FConstStructView UserData
) const

   SmartObjectSubsystem.h  

void FindSlotsInternal ( const FSmartObjectHandle Handle,
const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectRequestFilter& Filter,
TArray< FSmartObjectSlotHandle >& OutResults,
const FConstStructView UserData
) const

 Goes through all defined slots of smart object represented by SmartObjectRuntime and finds the ones matching the filter. SmartObjectSubsystem.h  

int32 GetRegisteredSmartObjectsCompatibleWithCollection ( const ASmartObjectPersistentCollection& InCollection,
TArray< USmartObjectComponent* >& OutRelevantComponents
) const

   SmartObjectSubsystem.h  
  SmartObjectSubsystem.h  

const FSmartObjectRuntime * GetRuntimeInstance ( const FSmartObjectHandle SmartObjectHandle
) const

   SmartObjectSubsystem.h  
Returns the runtime instance associated to the provided handle SmartObjectSubsystem.h  

const FSmartObjectRuntime * GetRuntimeInstanceInternal ( const FSmartObjectHandle SmartObjectHandle
) const

 Returns the const runtime instance associated to the provided handle SmartObjectSubsystem.h  

FSmartObjectRuntime * GetValidatedMutableRuntime ( const FSmartObjectHandle Handle,
const ANSICHAR* CallingFunctionName
) const

   SmartObjectSubsystem.h  

bool GetValidatedMutableRuntimeAndSlot ( const FSmartObjectSlotHandle SlotHandle,
FSmartObjectRuntime*& OutSmartObjectRuntime,
FSmartObjectRuntimeSlot*& OutSlot,
const ANSICHAR* CallingFunctionName
) const

   SmartObjectSubsystem.h  

bool GetValidatedMutableRuntimeAndSlotInternal ( const FSmartObjectSlotHandle& SlotHandle,
FSmartObjectRuntime*& OutSmartObjectRuntime,
FSmartObjectRuntimeSlot*& OutSlot,
const ANSICHAR* CallingFunctionName
) const

 Returns the mutable runtime instance associated to the provided handle Method produces log messages with provided context if provided handle is not set or associated instance can't be found. SmartObjectSubsystem.h  

FSmartObjectRuntime * GetValidatedMutableRuntimeInternal ( const FSmartObjectHandle Handle,
const ANSICHAR* CallingFunctionName
) const

 Returns the mutable runtime instance associated to the provided handle Method produces log messages with provided context if provided handle is not set or associated instance can't be found. SmartObjectSubsystem.h  

const FSmartObjectRuntime * GetValidatedRuntime ( const FSmartObjectHandle Handle,
const ANSICHAR* CallingFunctionName
) const

   SmartObjectSubsystem.h  

bool GetValidatedRuntimeAndSlot ( const FSmartObjectSlotHandle SlotHandle,
const FSmartObjectRuntime*& OutSmartObjectRuntime,
const FSmartObjectRuntimeSlot*& OutSlot,
const ANSICHAR* CallingFunctionName
) const

   SmartObjectSubsystem.h  

bool GetValidatedRuntimeAndSlotInternal ( const FSmartObjectSlotHandle& SlotHandle,
const FSmartObjectRuntime*& OutSmartObjectRuntime,
const FSmartObjectRuntimeSlot*& OutSlot,
const ANSICHAR* CallingFunctionName
) const

 Returns the const runtime instance associated to the provided handle. SmartObjectSubsystem.h  

const FSmartObjectRuntime * GetValidatedRuntimeInternal ( const FSmartObjectHandle Handle,
const ANSICHAR* CallingFunctionName
) const

 Returns the const runtime instance associated to the provided handle. SmartObjectSubsystem.h  

void InitializeRuntime()

 Creates all runtime data using main collection SmartObjectSubsystem.h  

bool IsRunningOnServer()

 Returns true if this subsystem is running on the server. SmartObjectSubsystem.h  

bool IsSlotValidVerbose ( const FSmartObjectSlotHandle& SlotHandle,
const ANSICHAR* CallingFunctionName
) const

 Indicates if the handle is set and the slot referred to is still accessible in the simulation. SmartObjectSubsystem.h  

void IterativelyBuildCollections()

 Iteratively adds items to registered collections. Expected to be called in World Partitined worlds. SmartObjectSubsystem.h  
  SmartObjectSubsystem.h  

const USmartObjectBehaviorDefinition * MarkSlotAsOccupiedInternal ( FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectClaimHandle& ClaimHandle,
TSubclassOf< USmartObjectBehaviorDefinition > DefinitionClass
)

   SmartObjectSubsystem.h  

void PopulateCollection ( ASmartObjectPersistentCollection& InCollection
) const

   SmartObjectSubsystem.h  

void RegisterCollectionInstances()

 Make sure that all SmartObjectCollection actors from our associated world are registered. SmartObjectSubsystem.h  
Finds the runtime instance associated to the collection entry and removes it from the simulation. SmartObjectSubsystem.h  

void RemoveComponentFromSimulation ( USmartObjectComponent& SmartObjectComponent
)

   SmartObjectSubsystem.h  

void RemoveComponentFromSimulation ( TNotNull< USmartObjectComponent* > SmartObjectComponent
)

 Finds the runtime instance associated to the component and removes it from the simulation. SmartObjectSubsystem.h  

bool RemoveRuntimeInstanceFromSimulation ( FSmartObjectRuntime& SmartObjectRuntime,
USmartObjectComponent* SmartObjectComponent
)

   SmartObjectSubsystem.h  

bool RemoveRuntimeInstanceFromSimulationInternal ( FSmartObjectRuntime& SmartObjectRuntime,
USmartObjectComponent* SmartObjectComponent
)

 Removes a runtime instance from the simulation. SmartObjectSubsystem.h  

void SetupConditionContextCommonData ( FWorldConditionContextData& ContextData,
const FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

void SetupConditionContextCommonDataInternal ( FWorldConditionContextData& ContextData,
const FSmartObjectRuntime& SmartObjectRuntime
) const

 Fills the provided context data with the smart object actor and handle associated to 'SmartObjectRuntime' and the subsystem. SmartObjectSubsystem.h  

bool TryActivatePreconditions ( const FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

bool TryActivatePreconditionsInternal ( const FSmartObjectRuntime& SmartObjectRuntime
) const

 Activate preconditions on the main object and all its slots. SmartObjectSubsystem.h  

void UnbindComponentFromSimulationInternal ( USmartObjectComponent& SmartObjectComponent,
FSmartObjectRuntime& SmartObjectRuntime
) const

   SmartObjectSubsystem.h  

void UnbindComponentFromSimulationInternal ( TNotNull< USmartObjectComponent* > SmartObjectComponent,
FSmartObjectRuntime& SmartObjectRuntime
) const

 Unbinds a smart object component from the given FSmartObjectRuntime instance. SmartObjectSubsystem.h  

bool UnregisterSmartObjectInternal ( USmartObjectComponent& SmartObjectComponent,
const bool bDestroyRuntimeState
)

   SmartObjectSubsystem.h  

bool UnregisterSmartObjectInternal ( TNotNull< USmartObjectComponent* > SmartObjectComponent,
const bool bDestroyRuntimeState
)

   SmartObjectSubsystem.h  

Overridden from UWorldSubsystem

Name Remarks Include Path Unreal Specifiers

virtual void OnWorldBeginPlay ( UWorld& World
)

 BeginPlay will push all objects stored in the collection to the runtime simulation and initialize octree using collection bounds. SmartObjectSubsystem.h  

virtual void OnWorldComponentsUpdated ( UWorld& World
)

 Callback overridden to gather loaded collections, spawn missing one and set the main collection. SmartObjectSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   SmartObjectSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 USubsystem BEGIN. SmartObjectSubsystem.h  

virtual bool ShouldCreateSubsystem ( UObject* Outer
) const

   SmartObjectSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddTagToInstance ( FSmartObjectRuntime& SmartObjectRuntime,
const FGameplayTag& Tag
)

   SmartObjectSubsystem.h  

static void AddTagToInstanceInternal ( FSmartObjectRuntime& SmartObjectRuntime,
const FGameplayTag& Tag
)

   SmartObjectSubsystem.h  

static void CreatePersistentCollectionFromDeprecatedData ( UWorld& World,
const ADEPRECATED_SmartObjectCollection& DeprecatedCollection
)

 Special-purpose function used to set up an instance of ASmartObjectPersistentCollection with data from a given instance of ADEPRECATED_SmartObjectCollection SmartObjectSubsystem.h  

static void FindMatchingSlotDefinitionIndices ( const USmartObjectDefinition& Definition,
const FSmartObjectRequestFilter& Filter,
TArray< int32 >& OutValidIndices
)

   SmartObjectSubsystem.h  

static void FindMatchingSlotDefinitionIndicesInternal ( const USmartObjectDefinition& Definition,
const FSmartObjectRequestFilter& Filter,
TArray< int32 >& OutValidIndices
)

 Applies filter on provided definition and fills OutValidIndices with indices of all valid slots. SmartObjectSubsystem.h  

static const USmartObjectBehaviorDefinition * GetBehaviorDefinition ( const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectSlotHandle SlotHandle,
TSubclassOf< USmartObjectBehaviorDefinition > DefinitionClass
)

   SmartObjectSubsystem.h  

static const USmartObjectBehaviorDefinition * GetBehaviorDefinitionInternal ( const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectSlotHandle& SlotHandle,
TSubclassOf< USmartObjectBehaviorDefinition > DefinitionClass
)

   SmartObjectSubsystem.h  

static USmartObjectSubsystem * GetCurrent ( const UWorld* World
)

   SmartObjectSubsystem.h  

static void OnSlotChanged ( const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectRuntimeSlot& Slot,
const FSmartObjectSlotHandle SlotHandle,
const ESmartObjectChangeReason Reason,
const FConstStructView Payload,
const FGameplayTag ChangedTag
)

   SmartObjectSubsystem.h  

static void OnSlotChangedInternal ( const FSmartObjectRuntime& SmartObjectRuntime,
const FSmartObjectRuntimeSlot& Slot,
const FSmartObjectSlotHandle& SlotHandle,
const ESmartObjectChangeReason Reason,
const FConstStructView Payload,
const FGameplayTag ChangedTag
)

   SmartObjectSubsystem.h  

static bool QueryAllValidatedEntranceLocations ( const UWorld* World,
const USmartObjectDefinition& SmartObjectDefinition,
const FTransform& SmartObjectTransform,
const AActor* SkipActor,
const FSmartObjectSlotEntranceLocationRequest& Request,
TArray< FSmartObjectSlotEntranceLocationResult >& Results
)

 Runs the entrance validation logic for all the slots in the smart object definition and returns all validated locations. SmartObjectSubsystem.h  

static void QueryValidatedSlotEntranceLocationsInternal ( const UWorld* World,
FSmartObjectValidationContext& ValidationContext,
const FSmartObjectSlotEntranceLocationRequest& Request,
const FSmartObjectSlotHandle& SlotHandle,
const FSmartObjectSlotDefinition& SlotDefinition,
const FTransform& SlotTransform,
const FSmartObjectSlotEntranceHandle& SlotEntranceHandle,
TFunctionRef< bool(const FSmartObjectSlotEntranceLocationResult&)> ResultFunc
)

 Validates entrance locations for a specific slot. SmartObjectSubsystem.h  

static void RemoveTagFromInstance ( FSmartObjectRuntime& SmartObjectRuntime,
const FGameplayTag& Tag
)

   SmartObjectSubsystem.h  

static void RemoveTagFromInstanceInternal ( FSmartObjectRuntime& SmartObjectRuntime,
const FGameplayTag& Tag
)

   SmartObjectSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page