unreal.InstancedActorsData

class unreal.InstancedActorsData(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

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. see: AInstancedActorsManager

C++ Source:

  • Plugin: InstancedActors

  • Module: InstancedActors

  • File: InstancedActorsData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • actor_class (type(Class)): [Read-Only] The fully realized actor type for these instances

  • id (uint16): [Read-Only] Identifying integer, unique within outer IAM, used for identifying matching persistence records Incrementally assigned in GetOrCreateActorInstanceData

  • instance_visualizations (Array[InstancedActorsVisualizationInfo]): [Read-Only] Sets of ISMCs which instances can swap between to change ‘visualization’ e.g: ‘with berries’, ‘without berries’

    InstanceVisualizations[0] is the default visualization, auto-created in BeginPlay from ActorClass and used by default for all spawned entities in BeginPlay.

    Additional visualizations can be registered at runtime with AddVisualization, for instances to switch to ( todo): see: AddVisualization, AddVisualizationAsync

  • tags (InstancedActorsTagSet): [Read-Only] Delimiting tag set to group sets of instances

get_manager() → InstancedActorsManager

Get Manager

Return type:

InstancedActorsManager