1. Epic GamesDeveloper
  3. UInstancedActorsModifierVolumeComponent

UInstancedActorsModifierVolumeComponent

A 3D volume component with a list of Modifiers to execute against any Instanced Actor's found within the volume.

API > API/Plugins > API/Plugins/InstancedActors

A 3D volume component with a list of Modifiers to execute against any Instanced Actor's found within the volume.

   
Name UInstancedActorsModifierVolumeComponent
Type class
Header File /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/Public/InstancedActorsModifierVolumeComponent.h
Include Path #include "InstancedActorsModifierVolumeComponent.h"

Syntax

UCLASS (MinimalAPI, ClassGroup="Instanced Actors",  
       HideCategories=(Object, HLOD, Lighting, VirtualTexture, Collision, TextureStreaming, Mobile, Physics, Tags, AssetUserData, Activation, Cooking, Navigation, Input, Mobility),  
       Meta=(BlueprintSpawnableComponent))  
class UInstancedActorsModifierVolumeComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UInstancedActorsModifierVolumeComponent ( const FObjectInitializer& ObjectInitializer
)

   InstancedActorsModifierVolumeComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDrawOnlyIfSelected bool   InstancedActorsModifierVolumeComponent.h
  • EditAnywhere
  • Category="Rendering"
bIgnoreOwnLevelsInstances bool If true, instances within the same outer level as this modifier volume will be skipped for modification. InstancedActorsModifierVolumeComponent.h
  • EditAnywhere
  • Category="Instanced Actor Modifier Volume"
Color FColor   InstancedActorsModifierVolumeComponent.h
  • EditAnywhere
  • Category="Rendering"
Extent FVector Local space volume half-extent (size along side = Extent * 2 * ComponentScale3D). InstancedActorsModifierVolumeComponent.h
  • Replicated
  • EditAnywhere
  • Category="Instanced Actor Modifier Volume"
  • Meta=(EditCondition="Shape==EInstancedActorsVolumeShape::Box", EditConditionHides)
LevelsToIgnore TArray< TSoftObjectPtr< UWorld > > If set, instances in IAMs which belong to these levels will be skipped (unaffected) by this modifier volume. InstancedActorsModifierVolumeComponent.h
  • Replicated
  • EditAnywhere
  • AdvancedDisplay
  • Category="Instanced Actor Modifier Volume"
LineThickness float   InstancedActorsModifierVolumeComponent.h
  • EditAnywhere
  • Category="Rendering"
Modifiers TArray< TObjectPtr< UInstancedActorsModifierBase > >   InstancedActorsModifierVolumeComponent.h
  • EditAnywhere
  • Category="Instanced Actor Modifier Volume"
  • Instanced
Radius float Local space volume radius (diameter = Radius * 2 * ComponentScale3D). InstancedActorsModifierVolumeComponent.h
  • Replicated
  • EditAnywhere
  • Category="Instanced Actor Modifier Volume"
  • Meta=(EditCondition="Shape==EInstancedActorsVolumeShape::Sphere", EditConditionHides)
Shape EInstancedActorsVolumeShape Volume bounds shape Note: Replicated only in the initial bunch InstancedActorsModifierVolumeComponent.h
  • Replicated
  • EditAnywhere
  • Category="Instanced Actor Modifier Volume"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void OnAddedToManager ( AInstancedActorsManager& Manager
)

 Called on addition to Manager in AInstancedActorsManager::AddModifierVolume. InstancedActorsModifierVolumeComponent.h  

void OnAddedToSubsystem ( UInstancedActorsSubsystem& InstancedActorSubsystem,
FInstancedActorsModifierVolumeHandle InModifierVolumeHandle
)

 Finds managers already registered with InInstancedActorSubsystem and adds this modifier to them. InstancedActorsModifierVolumeComponent.h  

void OnRemovedFromManager ( AInstancedActorsManager& Manager
)

 Called on removal from Manager in AInstancedActorsManager::RemoveModifierVolume. InstancedActorsModifierVolumeComponent.h  

bool TryRunPendingModifiers ( AInstancedActorsManager& Manager,
TBitArray<>& InOutPendingModifiers
)

 Executes Modifiers for all instances in Manager overlapped by this volume. InstancedActorsModifierVolumeComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   InstancedActorsModifierVolumeComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   InstancedActorsModifierVolumeComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   InstancedActorsModifierVolumeComponent.h  

virtual void EndPlay ( EEndPlayReason::Type Reason
)

   InstancedActorsModifierVolumeComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetLifetimeReplicatedProps ( TArray< FLifetimeProperty >& OutLifetimeProps
) const

   InstancedActorsModifierVolumeComponent.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page