USmartObjectSubsystem

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UWorldSubsystem

USmartObjectSubsystem

References

Module	SmartObjectsModule
Header	/Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/Public/SmartObjectSubsystem.h
Include	#include "SmartObjectSubsystem.h"

Syntax

UCLASS(Config=Game)
class USmartObjectSubsystem : public UWorldSubsystem

Remarks

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

Variables

	Name	Description
bool	bInitialCollectionAddedToSimulation	Flag to indicate that all entries from the baked collection are registered and new registrations will be considered runtime entries (i.e. no persistence)
ASmartObjectCol...	MainCollection
UE::SmartObject...	NextFreeUserID
FOnMainCollecti...	OnMainCollectionChanged
TArray< USmartO...	RegisteredSOComponents	List of registered used to rebuild collection on demand
TArray< FSmartO...	RuntimeCreatedEntries	Keep track of Ids associated to objects entirely created at runtime (i.e. not part of the initial collection)
TMap< FSmartObj...	RuntimeSmartObjects
FSmartObjectOct...	SmartObjectOctree

Constructors

	Name	Description
	USmartObjectSubsystem()

Functions

	Name	Description
void	AbortAll ( FSmartObjectRuntime& SmartObjectRu... )
void	AddToSimulation ( const FSmartObjectID ID, const USmartObjectDefinition& Defi..., const FTransform& Transform, const FBox& Bounds )
void	AddToSimulation ( const FSmartObjectCollectionEntry&..., const USmartObjectDefinition& Defi... )
void	AddToSimulation ( const USmartObjectComponent& )
FSmartObject...	Claim ( FSmartObjectID ID, const FSmartObjectRequestFilter& F... )
FSmartObject...	Claim ( const FSmartObjectRequestResult& R... )	Claim smart object from a valid request result.
void	ComputeBounds ( const UWorld& World, ASmartObjectCollection& Collection )	Compute bounds from given world and store result in provided collection
uint32	DebugGetNumRegisteredComponents()
uint32	DebugGetNumRuntimeObjects()
const TMap< ...	DebugGetRuntimeObjects()
void	DebugRegisterAllSmartObjects()	Debugging helpers to add all registered smart objects to the simulation
void	DebugUnregisterAllSmartObjects()	Debugging helper to remove all registered smart objects from the simulation
FSmartObject...	FindSlot ( const FSmartObjectID ID, const FSmartObjectRequestFilter& F... )	Goes through all defined slots of a given smart object and finds the first one matching the filter.
FSmartObject...	FindSlot ( const FSmartObjectRuntime& SmartOb..., const FSmartObjectRequestFilter& F... )	Goes through all defined slots of smart object represented by SmartObjectRuntime and finds the first one given actor can use.
FSmartObject...	FindSmartObject ( const FSmartObjectRequest& Request )	Spatial lookup
bool	FindSmartObjects ( const FSmartObjectRequest& Request, TArray< FSmartObjectRequestResult >... )	Spatial lookup
USmartObject...	GetCurrent ( const UWorld* World )
ASmartObject...	GetMainCollection()
FSmartObject...	GetMutableRuntimeSlot ( const FSmartObjectClaimHandle& Cla... )
const FSmart...	GetOctree()
TOptional< F...	GetSlotLocation ( const FSmartObjectRequestResult& R... )	Returns the position (in world space) of the slot associated to the given request result.
bool	GetSlotLocation ( const FSmartObjectClaimHandle& Cla..., FVector& OutSlotLocation )	Returns the position (in world space) of the slot associated to the given claim handle.
TOptional< F...	GetSlotLocation ( const FSmartObjectID SmartObjectID, const FSmartObjectSlotIndex SlotInd... )	Returns the position (in world space) of the slot represented by the provided object id and slot index.
TOptional< F...	GetSlotLocation ( const FSmartObjectClaimHandle& Cla... )	Returns the position (in world space) of the slot associated to the given claim handle.
bool	GetSlotTransform ( const FSmartObjectClaimHandle& Cla..., FTransform& OutSlotTransform )	Returns the transform (in world space) of the slot associated to the given claim handle.
TOptional< F...	GetSlotTransform ( const FSmartObjectID SmartObjectID, const FSmartObjectSlotIndex SlotInd... )	Returns the transform (in world space) of the slot represented by the provided object id and slot index.
TOptional< F...	GetSlotTransform ( const FSmartObjectRequestResult& R... )	Returns the transform (in world space) of the slot associated to the given request result.
TOptional< F...	GetSlotTransform ( const FSmartObjectClaimHandle& Cla... )	Returns the transform (in world space) of the slot associated to the given claim handle.
USmartObject...	GetSmartObjectComponent ( const FSmartObjectClaimHandle& Cla... )	Returns the component associated to the claim handle if still accessible.
void	RebuildCollection ( ASmartObjectCollection& InCollecti... )
ESmartObject...	RegisterCollection ( ASmartObjectCollection& InCollecti... )
void	RegisterCollectionInstances()	Make sure that all SmartObjectCollection actors from our associated world are registered.
void	RegisterSlotInvalidationCallback ( const FSmartObjectClaimHandle& Cla..., const FOnSlotInvalidated& Callback )	Register a callback to be notified if the claimed slot is no longer available and user need to perform cleanup.
bool	RegisterSmartObject ( USmartObjectComponent& SmartObject... )
bool	RegisterSmartObjectActor ( const AActor& SmartObjectActor )
bool	Release ( const FSmartObjectClaimHandle& Cla... )	Release claim on a smart object.
void	RemoveFromSimulation ( const FSmartObjectCollectionEntry&... )
void	RemoveFromSimulation ( const USmartObjectComponent& Smart... )
void	RemoveFromSimulation ( const FSmartObjectID ID )
void	SpawnMissingCollection()
void	UnregisterCollection ( ASmartObjectCollection& InCollecti... )
void	UnregisterSlotInvalidationCallback ( const FSmartObjectClaimHandle& Cla... )	Unregisters a callback to be notified if the claimed slot is no longer available and user need to perform cleanup.
bool	UnregisterSmartObject ( USmartObjectComponent& SmartObject... )
bool	UnregisterSmartObjectActor ( const AActor& SmartObjectActor )
const USmart...	Use ( const FSmartObjectClaimHandle& Cla..., const TSubclassOf< USmartObjectBeha... )	Start using a claimed smart object slot.
const Defini...	Use ( const FSmartObjectClaimHandle& Cla... )	Start using a claimed smart object slot.
const USmart...	Use ( FSmartObjectRuntime& SmartObjectRu..., const FSmartObjectClaimHandle& Cla..., const TSubclassOf< USmartObjectBeha... )

Overridden from UWorldSubsystem

		Name	Description
	void	OnWorldBeginPlay ( UWorld& World )	BeginPlay will push all objects stored in the collection to the runtime simulation and initialize octree using collection bounds.
	void	OnWorldComponentsUpdated ( UWorld& World )	Callback overriden to gather loaded collections, spawn missing one and set the main collection.