1. Epic GamesDeveloper
  3. AInstancedActorsManager

AInstancedActorsManager

Regional manager of 'instanced actors'.

API > API/Plugins > API/Plugins/InstancedActors

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Mass)  
class AInstancedActorsManager :  
    public APartitionActor ,  
    public ISMInstanceManager ,  
    public IActorInstanceManagerInterface

Remarks

Regional manager of 'instanced actors'.

Uses Mass to provide lightweight and efficient instancing of items in the distance, with server-authoritative actor spawning around players. AInstancedActorsManager's also provide replication and persistence for their managed instances.

Spawned and populated offline by UInstancedActorsSubsystem::InstanceActor. Offline population ensures client & server both load the same stable instance data and can commonly refer to instances by index as such.

Variables

  Type Name Description
Protected variable UProperty Transient bool bHasSpawnedEntities True if SpawnEntities has been called to spawn entities. Reset in EndPlay
Protected variable UProperty Transient FBox InstanceBounds World space cumulative instance bounds, calculated in BeginPlay
Protected variable FMassEntityQuery InstancedActorLocationQuery  
Protected variable UProperty Category, EditAnywhere TSubclassOf< UInstancedActorsData > InstancedActorsDataClass Class to be spawned to represent individual actor class instances.
Protected variable UProperty Transient TObjectPtr< UInstancedActorsSubsystem > InstancedActorSubsystem  
Protected variable UProperty Transient TMap< TObjectPtr< UInstancedStaticMeshComponent >, int32 > ISMComponentToInstanceDataMap  
Protected variable UProperty Transient FInstancedActorsManagerHandle ManagerHandle  
Protected variable TSharedPtr< FMassEntityManager > MassEntityManager  
Protected variable TArray< TWeakObjectPtr< UInstancedActorsModifierVolumeComponent > > ModifierVolumes Modifier volumes added via AddModifierVolume
Protected variable UProperty uint16 NextInstanceDataID Incremented in GetOrCreateActorInstanceData to provide IAD's with a stable, unique identifier within this IAM.
Protected variable TArray< TBitArray<> > PendingModifierVolumeModifiers A set of bit flags per volume in ModifierVolumes, matching each modifiers Modifiers list, marking whether the Modifier has yet to run on this manager or not (true = needs running).
Protected variable TBitArray PendingModifierVolumes A bit flag per volume in ModifierVolumes for whether the volume has pending Modifiers to run on this manager i.e if PendingModifierVolumeModifiers[VolumeIndex] has any true flags.
Protected variable UProperty Category instanced, visibleanywhere TArray< TObjectPtr< UInstancedActorsData > > PerActorClassInstanceData Per-actor-class instance data populated by AddActorInstance
Protected variable UProperty Category visibleanywhere FGuid SavedActorGuid Saved Actor Guid. Initialized from the actor name in constructor

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FInstancedActorsInstanceHandle

AddActorInstance ( TSubclassOf< AActor > ActorClass,
FTransform InstanceTransform,
bool bWorldSpace,
const FInstancedActorsTagSet& InstanceTags
)

 Adds an instance of ActorClass at InstanceTransform location to instance data
Public function void  
Public function Const void

AuditInstances ( FOutputDevice& Ar,
bool bDebugDraw,
float DebugDrawDuration
)

 Outputs instance metrics to Ar
Public function Static FBox

CalculateBounds ( TSubclassOf< AActor > ActorClass
)

 Helper function to deduce appropriate instanced static mesh bounds for ActorClass
Protected function Const FBox Calculate cumulative local space instance bounds for all PerActorClassInstanceData
Public function void Called by IA.CompactInstances console command to fully remove FreeList instances
Public function Virtual void

CreateISMComponents ( const FInstancedActorsVisualizationDesc& VisualizationDesc,
FConstSharedStruct SharedSettings,
TArray< TObjectPtr< UInstancedStaticMeshComponent > >& OutComponents,
const bool bEditorPreviewISMCs
)

  
Protected function Virtual UInstancedActorsData *

CreateNextInstanceActorData ( TSubclassOf< AActor > ActorClass,
const FInstancedActorsTagSet& InstanceTags
)

  
Protected function Virtual void Despawns all entities spawned by individual UInstancedActorsData instances.
Public function Const UInstancedActorsData *

FindInstanceDataByID ( uint16 InstanceDataID
)

 Searches PerActorClassInstanceData, returning the IAD with matching UInstancedActorsData::ID, if any(nullptr otherwise)
Public function Const bool  
Public function Const bool

ForEachInstance ( const TBoundsType& QueryBounds,
FInstanceOperationFunc InOperation,
FInstancedActorsIterationContext& IterationContext,
TOptional< FInstancedActorDataPredicateFunc > InstancedActorDataPredicate
)

  
Public function Const bool

ForEachInstance ( const FSphere& QueryBounds,
FInstanceOperationFunc Operation,
FInstancedActorsIterationContext& IterationContext,
TOptional< FInstancedActorDataPredicateFunc > InstancedActorDataPredicate
)

  
Public function Const bool

ForEachInstance ( const FBox& QueryBounds,
FInstanceOperationFunc Operation,
FInstancedActorsIterationContext& IterationContext,
TOptional< FInstancedActorDataPredicateFunc > InstancedActorDataPredicate
)

  
Public function Const bool Call InOperation for each valid instance in this manager.
Public function Const bool

ForEachInstance ( const TBoundsType& QueryBounds,
FInstanceOperationFunc InOperation
)

 Call InOperation for each valid instance in this manager whose location falls within QueryBounds.
Public function Const TConstArrayView< TObjectPtr< UInstancedActorsData > >  
Public function Const FBox  
Public function Const UInstancedActorsSubsystem *  
Public function Const UInstancedActorsSubsystem &  
Public function Const FInstancedActorsManagerHandle Inlines
Public function Const TSharedPtr< FMassEntityManager >  
Public function Const FMassEntityManager &  
Public function Const int32  
Protected function UInstancedActorsData & Helper function to create and initialize per-actor-class UInstancedActorsData's, optionally further partitioned by InstanceTags
Public function Const bool  
Public function Const bool

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

 Checks whether there are any instanced actors within this manager, representing ActorClass or its subclasses inside QueryBounds.
Public function Const bool  
Public function void Initializes all PerActorClassInstanceData, applies pre-spawn modifiers, spawns entities then applies post-spawn modifiers.
Public function Static UE::InstancedActors::EInsideBoundsTestResult

IsInstanceInsideBounds ( const FSphere& QueryBounds,
const FInstancedActorsInstanceHandle& InstanceHandle,
const FTransform& InstanceTransform
)

  
Public function Static UE::InstancedActors::EInsideBoundsTestResult

IsInstanceInsideBounds ( const TBoundsType& QueryBounds,
const FInstancedActorsInstanceHandle& InstanceHandle,
const FTransform& InstanceTransform
)

 Determines whether the actor instance given by InstanceHandle overlaps QueryBounds.
Public function Static UE::InstancedActors::EInsideBoundsTestResult

IsInstanceInsideBounds ( const FBox& QueryBounds,
const FInstancedActorsInstanceHandle& InstanceHandle,
const FTransform& InstanceTransform
)

  
Public function Const bool  
Public function void

OnAddedToSubsystem ( UInstancedActorsSubsystem& InInstancedActorSubsystem,
FInstancedActorsManagerHandle InManagerHandle
)

 Adds modifiers already registered with InInstancedActorSubsystem and either calls InitializeModifyAndSpawnEntities to spawn entities immediately, or schedules deferred call by InInstancedActorSubsystem if IA.DeferSpawnEntities is enabled.
Protected function void Called when persistent data has been applied / restored
Public function void

RegisterInstanceDatasComponents ( const UInstancedActorsData& InstanceData,
TConstArrayView< TObjectPtr< UInstancedStaticMeshComponent > > Components
)

 Registers Components as related to InstanceData for IActorInstanceManagerInterface-related purposes.
Public function bool Removes all instance data for InstanceHandle.
Public function void  
Public function void  
Protected function Virtual void Mz
Public function void Request the persistent data system to re-save this managers persistent data
Public function void Removes all instances as if they were never present i.e: these removals are not persisted as if made by a player.
Protected function Const void Called by Serialize for SaveGame archives to save / load IAD persistence data
Public function void

SetGridGuid ( const FGuid& InGuid
)

  
Protected function void Attempts to run any 'pending' modifiers in ModifierVolumes where are appropriate to run given HasSpawnedEntities Called in BeginPlay prior to, and then again after SpawnEntities.
Public function void Unregisters Component from IActorInstanceManagerInterface-related tracking.
Public function Static void

UpdateInstanceStats ( int32 InstanceCount,
EInstancedActorsBulkLOD LODMode,
bool Increment
)

  

Overridden from APartitionActor

  Type Name Description
Public function Virtual Const uint32

GetDefaultGridSize ( UWorld* InWorld
)

  
Public function Virtual Const FGuid  

Overridden from AActor

  Type Name Description
Protected function Virtual void Overridable native event for when play begins for this actor.
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Protected function Virtual Const void

GetStreamingBounds ( FBox& OutRuntimeBounds,
FBox& OutEditorBounds
)

 Returns the bounding boxes of all components that make up this Actor for loading at runtime and editor.
Protected function Virtual Const bool Indicates whether this actor contributes to the HLOD generation.
Protected function Virtual Const bool Used to know if actor supports some editor operations. (Delete, Replace)
Protected function Virtual void Used to set the right properties on the editor ISMCs so we can do per-instance selection.

Overridden from UObject

  Type Name Description
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void  

Overridden from IActorInstanceManagerInterface

  Type Name Description
Protected function Virtual Const int32

ConvertCollisionIndexToInstanceIndex ( int32 InIndex,
const UPrimitiveComponent* RelevantComponent
)

 Returns the index used internally by the actor instance manager that is associated with the instance referred to by InIndex used by collision and rendering
Protected function Virtual AActor *

FindActor ( const FActorInstanceHandle& Handle
)

 Returns the actor associated with Handle if one exists.
Protected function Virtual AActor * Returns the actor associated with Handle. If one does not exist the system is expected to spawn one instantly.
Protected function Virtual Const ULevel *

GetLevelForInstance ( const int32 InstanceIndex
)

 Returns the ULevel given instance is represented in. Potentially null if InstanceIndex doesn't correspond to an actor.
Protected function Virtual Const UClass *

GetRepresentedClass ( const int32 InstanceIndex
)

 Returns the specific class InstanceIndex represents.
Protected function Virtual Const FTransform Returns the transform of the instance specified by Handle.

Typedefs

Name Description
FInstancedActorDataPredicateFunc Predicate taking a UInstancedActorsData and returns true if IAD matches search criteria, false otherwise.
FInstanceOperationFunc Iteration callback for ForEachInstance

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page