1. Epic GamesDeveloper
  3. InstancedActors

InstancedActors

API > API/Plugins

   
Name InstancedActors
Type Runtime
Part of Plugins InstancedActors
Location /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/
Module Build Rules InstancedActors.Build.cs

Classes

Name Remarks
AInstancedActorsManager Regional manager of 'instanced actors'.
AInstancedActorsModifierVolume A 3D volume with a list of Modifiers to execute against any Instanced Actor's found within the volume.
AInstancedActorsRemovalModifierVolume A 3D volume that performs filtered removal of Instanced Actor's found within the volume.
UClientInstancedActorsSpawnerSubsystem Used on Clients to handle actor spawning synchronized with the Server.
UGameFeatureAction_ConfigureInstancedActors GameplayFeature Action carrying overrides to InstancedActors settings
UInstancedActorsComponent Provides Mass Entity reference and interop functions for Actors spawned via Instanced Actors on both client & server.
UInstancedActorsData Instance data for all instances of a given AActor class.
UInstancedActorsDebugProcessor  
UInstancedActorsInitializerProcessor Initializes the fragments of all entities that fit the query specified in ConfigureQueries, which are all considered Instanced Actors.
UInstancedActorsModifierBase Base class for 'modifier' operations to run against Instanced Actors within AInstancedActorsManager's
UInstancedActorsModifierVolumeComponent A 3D volume component with a list of Modifiers to execute against any Instanced Actor's found within the volume.
UInstancedActorsProjectSettings Configurable project settings for the Instanced Actors system.
UInstancedActorsRepresentationActorManagement  
UInstancedActorsRepresentationSubsystem  
UInstancedActorsStationaryLODBatchProcessor  
UInstancedActorsSubsystem Instanced Actor subsystem used to spawn AInstancedActorsManager's and populate their instance data.
UInstancedActorsVisualizationProcessor  
UInstancedActorsVisualizationSwitcherProcessor Executes on entities with FInstancedActorsMeshSwitchFragment's, processing them as `pending requests_ to switch to the specified NewStaticMeshDescHandle, then removing the fragments once complete
UInstancedActorsVisualizationTrait Subclass of UMassStationaryVisualizationTrait which forces required settings for instanced actor entities and overrides FMassRepresentationFragment.StaticMeshDescHandle to use a custom registered Visualization which reuses InstanceData's ISMComponents via UMassRepresentationSubsystem::AddVisualDescWithISMComponent.
URemoveInstancedActorsModifier Modifier which removes all affected instances using AInstancedActorsManager::RuntimeRemoveInstances for individual instances.
URemoveInstancesModifierVolumeComponent A UInstancedActorsModifierVolumeComponent with a URemoveInstancedActorsModifier modifier pre-added to Modifiers
UServerInstancedActorsSpawnerSubsystem Dedicated UMassActorSpawnerSubsystem subclass handling server-side Actor spawning for InstancedActor.

Structs

Name Remarks
FBulkLODTagsChangeCommandBase  
FClassConfigOverrideEntry  
FEnableBatchLODCommand Removes GetDetailedLODTags() from an entity, effectively enabling BatchLOD processing on it
FEnableDetailedLODCommand Adds GetDetailedLODTags() to an entity, effectively enabling DetailedLOD processing on it
FExemplarActorData  
FInstancedActorsClassSettings Generic implementation of FInstancedActorsClassSettingsBase that's using the generic FInstancedActorsSettings to override existing settings.
FInstancedActorsClassSettingsBase Per-class settings for instanced actors.
FInstancedActorsConfig  
FInstancedActorsCustomVersion  
FInstancedActorsDataSharedFragment Note that we don't really need this type to be a shared fragment.
FInstancedActorsDelta Per-instance delta's against the cooked instance data, for persistence and replication
FInstancedActorsDeltaList  
FInstancedActorsFragment  
FInstancedActorsInstanceHandle  
FInstancedActorsInstanceIndex This type is only valid to be used with the instance of UInstancedActorsData it applies to.
FInstancedActorsIterationContext Provides useful functionality while iterating instances like safe instance deletion.
FInstancedActorsManagerHandle  
FInstancedActorsMassSpawnData  
FInstancedActorsMeshSwitchFragment  
FInstancedActorsModifierVolumeHandle  
FInstancedActorsSettings Settings for controlling Instanced Actor behavior.
FInstancedActorsSoftVisualizationDesc Soft-ptr variant of FInstancedActorsVisualizationDesc for defining visualization assets to async load.
FInstancedActorsTagSet FInstancedActorsTagSet -> FInstancedActorsTagSet.
FInstancedActorsVisualizationDesc ISMC descriptions for instances 'visualization', allowing instances to define multiple potential visualizations / ISMC sets: e.g: 'with berries', 'without berries'.
FInstancedActorsVisualizationInfo Runtime ISMC tracking for a given 'visualization' (alternate ISMC set) for instances
FInstancedActorsVisualizationProcessorTag Tag required by Instanced Actors Visualization Processor to process given archetype.
FMassCommandAddFragmentInstancesAndResaveIAPersistence Note: TManagerType is always expected to be AInstancedActorsManager, but is declared as template's param to maintain uniform command adding interface via FMassCommandBuffer.PushCommand.
FScopedInstancedActorsIterationContext Subclass of FInstancedActorsIterationContext that calls FlushDeferredActions in it's destructor

Interfaces

Name Remarks
IInstancedActorsModule The public interface to this module.

Enums

Public

Name Remarks
EInstancedActorsBulkLOD  
EInstancedActorsBulkLODMask  
EInstancedActorsFragmentFlags  
EInstancedActorsVolumeShape  
UE::InstancedActors::EBoundsTestType  
UE::InstancedActors::EInsideBoundsTestResult  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Both int32   InstancedActorsDebug.h  
DebugDraw int32   InstancedActorsDebug.h  
None int32   InstancedActorsDebug.h  
STATCAT_Advanced     InstancedActorsManager.h  
VisLog int32   InstancedActorsDebug.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool operator! ( EInstancedActorsFragmentFlags E
)

   InstancedActorsTypes.h  
  InstancedActorsTypes.h  
  InstancedActorsTypes.h  
  InstancedActorsTypes.h  
  InstancedActorsTypes.h  
  InstancedActorsTypes.h  
  InstancedActorsTypes.h  
  InstancedActorsTypes.h  

void UE::InstancedActors::Debug::DebugDrawLocation ( const int32& DebugDrawMode,
const UWorld* World,
const UObject* LogOwner,
const CategoryType& CategoryName,
ELogVerbosity::Type Verbosity,
const FVector& Location,
float Size,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

   InstancedActorsDebug.h  

void UE::InstancedActors::Debug::DebugDrawSphere ( const int32& DebugDrawMode,
const UWorld* World,
const UObject* LogOwner,
const CategoryType& CategoryName,
ELogVerbosity::Type Verbosity,
const FSphere& Sphere,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

   InstancedActorsDebug.h  

void UE::InstancedActors::Debug::DrawDebugSolidBox ( const int32& DebugDrawMode,
const UWorld* World,
const UObject* LogOwner,
const CategoryType& CategoryName,
ELogVerbosity::Type Verbosity,
const FBox& Box,
const FColor& Color,
const FmtType& Fmt,
Types... Args
)

   InstancedActorsDebug.h  

bool UE::InstancedActors::Debug::ShouldDebugDraw ( const int32& DebugDrawMode
)

   InstancedActorsDebug.h  

bool UE::InstancedActors::Debug::ShouldVisLog ( const int32& DebugDrawMode
)

   InstancedActorsDebug.h  

bool UE::InstancedActors::PassesBoundsTest ( const TBoundsType& QueryBounds,
EBoundsTestType BoundsTestType,
const FInstancedActorsInstanceHandle& InstanceHandle,
const FTransform& InstanceTransform
)

   InstancedActorsManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page