1. Epic GamesDeveloper
  3. UInstancedActorsSubsystem

UInstancedActorsSubsystem

Instanced Actor subsystem used to spawn [AInstancedActorsManager](API\Plugins\InstancedActors\AInstancedActorsManager)'s and populate their instance data.

API > API/Plugins > API/Plugins/InstancedActors

Inheritance Hierarchy

References

   
Module InstancedActors
Header /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/Public/InstancedActorsSubsystem.h
Include #include "InstancedActorsSubsystem.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UInstancedActorsSubsystem : public UTickableWorldSubsystem

Remarks

Instanced Actor subsystem used to spawn AInstancedActorsManager's and populate their instance data. It also keeps track of all InstancedActorDatas and can be queried for them

Variables

  Type Name Description
Protected variable UProperty Transient TObjectPtr< UActorPartitionSubsystem > ActorPartitionSubsystem  
Protected variable UProperty Transient TObjectPtr< const UDataRegistrySubsystem > DataRegistrySubsystem  
Protected variable TArray< FInstancedActorsInstanceHandle > DirtyRepresentationInstances Instances whose representation is explicitly dirty, e.g: due to actor spawn / despawn replication, requiring immediate representation processing even out of 'detailed' representation processing range.
Protected variable TSharedPtr< FMassEntityManager > EntityManager  
Protected variable TMap< TObjectKey< const UClass >, TWeakPtr< UE::InstancedActors::FExemplarActorData > > ExemplarActors Lazily created exemplar actors for instance actor classes
Protected variable UProperty Transient TObjectPtr< UWorld > ExemplarActorWorld Inactive UWorld housing lazily create exemplar actors for instance actor classes
Protected variable UProperty TSubclassOf< AInstancedActorsManager > InstancedActorsManagerClass  
Protected variable TSparseArray< TWeakObjectPtr< AInstancedActorsManager > > Managers Spatially indexed managers.
Protected variable FManagersHashGridType ManagersHashGrid  
Protected variable TSparseArray< TWeakObjectPtr< UInstancedActorsModifierVolumeComponent > > ModifierVolumes Spatially indexed modifier volumes. TSparseArray used for stable indices which can be spatially indexed by THierarchicalHashGrid2D.
Protected variable FModifierVolumesHashGridType ModifierVolumesHashGrid  
Protected variable TArray< FInstancedActorsManagerHandle > PendingManagersToSpawnEntities FIFO queue of Managers pending deferred entity spawning in Tick. Enqueued in RequestDeferredSpawnEntities.
Protected variable TMap< TWeakObjectPtr< UClass >, FSharedStruct > PerActorClassSettings Cached finalized / flattened FInstancedActorsClassSettingsBase for GetOrCompileSettingsForActorClass requested ActorClass.
Protected variable UProperty Transient TObjectPtr< const UInstancedActorsProjectSettings > ProjectSettings  
Protected variable UProperty Transient TObjectPtr< const UScriptStruct > SettingsType  
Protected variable TArray< FNextTickSharedFragment > SortedSharedFragments The container storing a sorted queue of FSharedStruct instances, ordered by the NextTickTime

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FInstancedActorsManagerHandle  
Public function FInstancedActorsModifierVolumeHandle  
Public function bool Removes ManagerHandle from PendingManagersToSpawnEntities if present
Protected function Const FSharedStruct Called in GetOrCompileSettingsForActorClass to compile finalized settings for ActorClass based off FInstancedActorsClassSettingsBase found in UInstancedActorsProjectSettings::ActorClassSettingsRegistryType data registry, for ActorClass and it's inherited super classes.
Public function Virtual Const FInstancedActorsVisualizationDesc

CreateVisualDescriptionFromActor ( const AActor& ExemplarActor
)

  
Public function bool

DoesActorClassHaveRegisteredSettings ( TSubclassOf< AActor > ActorClass,
bool bIncludeSuperClasses
)

 Returns true if ActorClass has a matching FInstancedActorsClassSettingsBase entry in UInstancedActorsProjectSettings::ActorClassSettingsRegistryType data registry.
Public function bool

ExecutePendingDeferredSpawnEntitiesRequests ( double StopAfterSeconds
)

 Calls AInstancedActorsManager::InitializeModifyAndSpawnEntities for all pending managers in PendingManagersToSpawnEntities added via RequestDeferredSpawnEntities.
Public function Const void  
Public function Const void

ForEachManager ( const FBox& QueryBounds,
TFunctionRef< bool(AInstancedActorsManager&)> InOperation,
TSubclassOf< AInstancedActorsManager > ManagerClass
)

  
Public function Const void  
Public function Static UInstancedActorsSubsystem *

Get ( UObject* WorldContextObject
)

  
Public function Static UInstancedActorsSubsystem &

GetChecked ( UObject* WorldContextObject
)

  
Public function Const TSubclassOf< AInstancedActorsManager >  
Public function FSharedStruct Compiles and caches finalized settings for ActorClass based off FInstancedActorsClassSettingsBase found in UInstancedActorsProjectSettings::ActorClassSettingsRegistryType data registry, for ActorClass and it's inherited super classes.
Public function TSharedRef< UE::InstancedActors::FExemplarActorData > Retrieves existing or spawns a new ActorClass for introspecting exemplary instance data.
Public function TArray< UInstancedActorsSubsystem::FNextTickSharedFragment > &  
Protected function void  
Public function Const bool

HasInstancesOfClass ( const FBox& QueryBounds,
TSubclassOf< AActor > ActorClass,
const bool bTestActorsIfSpawned,
const EInstancedActorsBulkLODMask AllowedLODs
)

 Checks whether there are any instanced actors representing ActorClass or its subclasses inside QueryBounds.
Public function Const bool Return true if any deferred spawn entities requests are pending execution by the next ExecutePendingDeferredSpawnEntitiesRequests
Public function FInstancedActorsInstanceHandle

InstanceActor ( TSubclassOf< AActor > ActorClass,
FTransform InstanceTransform,
ULevel* Level,
const FGameplayTagContainer& InstanceTags
)

 Adds an instance of ActorClass at InstanceTransform location by spawning or reusing a AInstancedActorsManager at InstanceTransform's grid cell location.
Public function UFunction BlueprintCallable, Category FInstancedActorsInstanceHandle

InstanceActor ( TSubclassOf< AActor > ActorClass,
FTransform InstanceTransform,
ULevel* Level,
const FGameplayTagContainer& InstanceTags,
TSubclassOf< AInstancedActorsManager > ManagerClass
)

 Adds an instance of ActorClass at InstanceTransform location by spawning or reusing a AInstancedActorsManager at InstanceTransform's grid cell location.
Public function void Adds InstanceHandle to a list of pending instances that require an explicit representation update e.g: to remove/add ISMCs when a replicated actor is spawned / despawned.
Public function void Copies the current list of instances requiring explicit representation updates (added via MarkInstanceRepresentationDirty) to OutInstances and clears the internal list.
Protected function bool Fetches all registered FInstancedActorsDataSharedFragment from the EntityManager and adds the missing ones to SortedSharedFragments
Public function UFunction BlueprintCallable, Category bool

RemoveActorInstance ( const FInstancedActorsInstanceHandle& InstanceHandle,
bool bDestroyManagerIfEmpty
)

 Removes all instance data for InstanceHandle.
Public function void  
Public function void  
Public function void Adds ManagerHandle to PendingManagersToSpawnEntities for later processing in Tick -> ExecutePendingDeferredSpawnEntitiesRequests
Public function void Removes exemplar actor class from the map
Public function void  

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void USubsystem implementation Begin.
Public function Virtual Const bool Override to control if the Subsystem should be created at all.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id used to track the performance of this object
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Classes

  Type Name Description
Public struct FNextTickSharedFragment    

Typedefs

Name Description
FManagersHashGridType  
FModifierVolumesHashGridType  

See Also

AInstancedActorsManager

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page