1. Epic GamesDeveloper
  3. UInstancedActorsData

UInstancedActorsData

Instance data for all instances of a given [AActor](API\Runtime\Engine\GameFramework\AActor) class.

API > API/Plugins > API/Plugins/InstancedActors

Inheritance Hierarchy

References

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

Syntax

UCLASS (DefaultToInstanced)  
class UInstancedActorsData : public UObject

Remarks

Instance data for all instances of a given AActor class. Provides 'stable' referral to instances by index via offline population of InstanceTransforms which is then consistently loaded on both client and server.

Variables

  Type Name Description
Public variable UProperty Category visibleanywhere TSubclassOf< AActor > ActorClass The fully realized actor type for these instances.
Public variable friend AInstancedActorsManager  
Protected variable UProperty FBox AssetBounds Editor time cached bounds for AssetClass, used during editor-only instance creation and deletion to expand / contract Bounds
Protected variable bool: 1 = false bHasEverInitialized True if Initialize has ever been called.
Public variable UProperty FBox Bounds Cumulative mesh bounds for all of InstanceTransfroms.
Protected variable bool: 1 = false bRemovingInstances True during RuntimeRemoveInstances to prevent recursion via OnInstancedActorDestroyed.
Protected variable UProperty TArray< TObjectPtr< UInstancedStaticMeshComponent > > EditorPreviewISMComponents ISMCs created in GetOrCreateActorInstanceData to match default visualizations ISMComponents for editor only preview of instances.
Public variable UProperty Transient TArray< FMassEntityHandle > Entities Runtime spawned mass instances
Public variable FMassEntityTemplateID EntityTemplateID The entity template to spawn Mass entities from
Public variable UProperty Category visibleanywhere uint16 ID Identifying integer, unique within outer IAM, used for identifying matching persistence records Incrementally assigned in GetOrCreateActorInstanceData
Public variable UProperty TArray< FTransform > InstanceTransforms Void UInstancedActorsData::AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector)
Protected variable TBitArray InstanceVisualizationAllocationFlags Allocation bit flags for InstanceVisualizations to allow for TSpareArray-like removal of visualization without affecting remaining visualization indices.
Protected variable UProperty Category Transient visibleanywhere TArray< FInstancedActorsVisualizationInfo > InstanceVisualizations Sets of ISMCs which instances can swap between to change 'visualization' e.g: 'with berries', 'without berries'
Public variable float LowLODDrawDistance Distance from where the lowest LOD will be rendered - auto computed from bounding box and screen size data stored in the StaticMesh or can be set via the settings.
Public variable float MaxDrawDistance Distance from where the object will be culled out - auto computed from bounding box radius or can be set per via the settings.
Public variable UProperty Transient uint16 NumInstances InstanceTransforms.Num() cached in PostLoad so we can restore InstanceTransforms to this size in ResetInstanceData
Public variable UProperty uint16 NumValidInstances InstanceTransforms.Num() - number of invalid transforms Note: This is only valid prior to Entity spawning when InstanceTransforms is also valid, after which, spawned entities may be later removed / culled at runtime, invalidating this number.
Protected variable FConstSharedStruct SharedSettings Compiled settings for these instances, compiled and cached in BeginPlay.
Public variable UProperty Category visibleanywhere FInstancedActorsTagSet Tags Delimiting tag set to group sets of instances.

Functions

  Type Name Description
Public function FInstancedActorsInstanceHandle

AddInstance ( const FTransform& Transform,
const bool bWorldSpace
)

 Add's an instance of this actor type at Transform
Public function uint8 Register additional / alternate VisualizationDesc for instances to switch to, creating ISMC's for each VisualizationDesc.InstancedMeshes
Public function uint8 Register additional / alternate VisualizationDesc for instances to switch to, creating ISMC's for each VisualizationDesc.InstancedMeshes
Protected function uint8 Adds or reuses a previously removed entry in InstanceVisualizations
Protected function Virtual void

ApplyInstanceDelta ( FMassEntityManager& EntityManager,
const FInstancedActorsDelta& InstanceDelta,
TArray< FInstancedActorsInstanceIndex >& OutEntitiesToRemove
)

 Helper function used in ApplyInstanceDeltas to apply a single delta
Public function void Called on both server and client to apply instance delta changes to mass entities On servers: Called by OnPersistentDataRestored after persistence record has deserialized the delta data On clients: Called by OnRep_InstanceDeltas when new delta data has replicated from the server
Public function void

ApplyInstanceDeltas ( TConstArrayView< int32 > InstanceDeltaIndices
)

  
Public function void Called in UInstancedActorsComponent::EndPlay on clients to clear / unset the current actor for Instance's mass entity.
Protected function void

CreateEntityTemplate ( const AActor& ExemplarActor
)

 Called on BeginPlay to create default entity template.
Public function void Called early in AInstancedActorsManager::EndPlay to reconstruct cooked data state from runtime Mass entities as best we can, then despawn all Mass entities and reset any other runtime instance data
Public function void Authority: Permanently destroy InstanceToDestroy by adding it to the persistent DestroyedInstances list and deleting it's Mass entity (deleting any Mass-spawned actors in turn).
Public function Virtual void

EjectInstanceActor ( FInstancedActorsInstanceIndex InstanceToEject,
AActor& ActorToEject
)

 Authority: `Eject_ an instance by unlinking it's Actor from Mass, setting the actor to persist itself and then destroying the manager instance.
Public function Const void

ForEachVisualization ( TFunctionRef< bool(uint8, const FInstancedActorsVisualizationInfo&)> InFunction,
bool bSkipAsyncLoadingVisualizations
)

 Iterates all currently 'allocated' visualizations previously added with AddVisualization or AddVisualizationAsync
Public function Const EInstancedActorsBulkLOD  
Public function Const FString

GetDebugName ( bool bCompact
)

 Returns a string useful for identifying this instance data object withing it's owning manager
Public function Const const FInstancedActorsVisualizationInfo & Returns the default visualization auto-created in BeginPlay from ActorClass and used by default for all spawned entities in BeginPlay.
Public function Const FMassEntityHandle  
Public function Const FMassEntityHandle  
Public function Const int32

GetEntityIndexFromCollisionIndex ( const UInstancedStaticMeshComponent& ISMComponent,
const int32 CollisionIndex
)

  
Public function Static UInstancedActorsData *

GetInstanceDataForEntity ( const FMassEntityManager& EntityManager,
const FMassEntityHandle EntityHandle
)

 Returns the 'owning' UInstancedActorsData for EntityHandle by checking it's FInstancedActorsFragment (if any) returning nullptr for unknown entities.
Public function Const int32  
Public function Const const FInstancedActorsDeltaList &  
Public function Const FInstancedActorsInstanceIndex  
Public function Const UFunction BlueprintPure, Category AInstancedActorsManager *  
Public function Const AInstancedActorsManager &  
Public function Const FMassEntityManager &  
Public function FInstancedActorsDeltaList &  
Public function Const int32 Returns the current invalid instance count, if any (i.e: GetNumInstances() - NumValidInstances)
Public function Const int32 Returns the total instance count, including both valid & invalid instances e.g: GetNumFreeInstances() + NumValidInstances Useful for iterating by FInstancedActorsInstanceIndex or allocating same-sized instance data arrays
Public function Const const std::remove_const_t< T > &  
Public function Const const std::remove_const_t< T > *  
Public function Const const FInstancedActorsVisualizationInfo *

GetVisualization ( uint8 VisualizationIndex
)

 Get runtime visualization info by index for visualizations added with AddVisualization.
Public function Const const FInstancedActorsVisualizationInfo &

GetVisualizationChecked ( uint8 VisualizationIndex
)

 Get runtime visualization info by index for visualizations added with AddVisualization.
Public function Const bool Returns true if InstanceTransforms has been consumed to spawn Mass entities.
Public function void Called early in AInstancedActorsManager::InitializeModifyAndSpawnEntities to intitalize Settings, default visualization & Mass entity template.
Protected function void

InitializeVisualization ( uint8 AllocatedVisualizationIndex,
const FInstancedActorsVisualizationDesc& VisualizationDesc
)

 Creates ISMCs for VisualizationDesc.InstancedMeshes, registers them with Mass and sets FInstancedActorsVisualizationInfo::MassStaticMeshDescIndex with the newly registed ISMC decription index
Public function Const bool Returns true if InstanceHandle refers to this instance data and we have current information for an instance at InstanceHandle.InstanceIndex
Protected function Virtual void

ModifyEntityTemplate ( FMassEntityTemplateData& ModifiedTemplate,
const AActor& ExemplarActor
)

  
Public function void

OnInstancedActorDestroyed ( AActor& DestroyedActor,
const FMassEntityHandle EntityHandle
)

 Called by UInstancedActorsRepresentationActorManagement when a managed actor is destroyed.
Public function bool

OnInstancedActorMoved ( AActor& MovedActor,
const FMassEntityHandle EntityHandle
)

 Called by UInstancedActorsRepresentationActorManagement when a managed actor is moved
Public function void Called when persistent data has been applied / restored.
Public function void

OnRep_InstanceDeltas ( TConstArrayView< int32 > UpdatedInstanceDeltaIndices
)

 Called by FInstancedActorsDeltaList::PostReplicatedAdd and PostReplicatedChanged on InstanceDelta replication.
Public function void

OnRep_PreRemoveInstanceDeltas ( TConstArrayView< int32 > RemovedInstanceDeltaIndices
)

 Called by FInstancedActorsDeltaList::PreReplicatedRemove on InstanceDelta removal replication (just before the actual array element removal)
Public function void Remove all previously registered instance visualization, deleting all ISMC's.
Public function bool

RemoveInstance ( const FInstancedActorsInstanceHandle& InstanceToRemove
)

 Removes all instance data for InstanceHandle.
Public function void Mz
Public function void Mz
Public function void

RemoveVisualization ( uint8 VisualizationIndex
)

 Remove previously registered instance visualization, deleting all ISMC's.
Protected function Virtual void

RollbackInstanceDelta ( FMassEntityManager& EntityManager,
const FInstancedActorsDelta& InstanceDelta
)

 Helper function used in RollbackInstanceDeltas to rollback a single delta
Public function void

RollbackInstanceDeltas ( TConstArrayView< int32 > InstanceDeltaIndices
)

 Called on clients by OnRep_PreRemoveInstanceDeltas to revert instance delta change to mass entities
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.
Public function void

RuntimeRemoveInstances ( TConstArrayView< FInstancedActorsInstanceIndex > RuntimeRemoveInstances
)

 Removes RuntimeRemoveInstances as if they were never present i.e: these removals are not persisted as if made by a player.
Public function void

SetInstanceCurrentLifecyclePhase ( FInstancedActorsInstanceIndex InstanceIndex,
uint8 InCurrentLifecyclePhaseIndex
)

 Mz
Public function bool

SetInstanceTransform ( const FInstancedActorsInstanceHandle& InstanceHandle,
const FTransform& Transform,
const bool bWorldSpace
)

 Set/update the transform for an instance.
Public function void Called in UInstancedActorsComponent::OnRep_InstanceHandle on clients to set ReplicatedActor as the current actor for Instance's mass entity.
Public function void  
Public function void

SetSharedSettings ( const FConstSharedStruct& InSharedSettings
)

  
Public function void Called in AInstancedActorsManager::InitializeModifyAndSpawnEntities to spawn Mass entities for each instance.
Public function void

SwitchInstanceVisualization ( FInstancedActorsInstanceIndex InstanceToSwitch,
uint8 NewVisualizationIndex
)

 Switches InstanceToSwitch to use the 'visualization' at NewVisualizationIndex, previoulsy added via AddVisualzation.
Protected function AActor * Unlink InstanceToUnlink's Actor (if any) from Mass by clearing the entities reference to it and disconnecting from any subscribed actor signals, essentially 'forgetting' about the actor.
Public function Virtual void  

Overridden from UObject

  Type Name Description
Protected function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel
Protected function Virtual Const bool IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network
Protected function Virtual void  
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

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