Navigation
API > API/Plugins > API/Plugins/InstancedActors
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- USceneComponent
- UPrimitiveComponent
- UInstancedActorsModifierVolumeComponent
- URemoveInstancesModifierVolumeComponent
References
| Module | InstancedActors |
| Header | /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/Public/InstancedActorsModifierVolumeComponent.h |
| Include | #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
Remarks
A 3D volume component with a list of Modifiers to execute against any Instanced Actor's found within the volume.
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
bool | bDrawOnlyIfSelected | |
   |
bool | bIgnoreOwnLevelsInstances | If true, instances within the same outer level as this modifier volume will be skipped for modification. |
   |
FColor | Color | |
    |
FVector | Extent | Local space volume half-extent (size along side = Extent * 2 * ComponentScale3D). |
    |
TArray< TSoftObjectPtr< UWorld > > | LevelsToIgnore | If set, instances in IAMs which belong to these levels will be skipped (unaffected) by this modifier volume. |
   |
float | LineThickness | |
   |
TArray< TWeakObjectPtr< AInstancedActorsManager > > | ModifiedManagers | |
    |
TArray< TObjectPtr< UInstancedActorsModifierBase > > | Modifiers | |
   |
FInstancedActorsModifierVolumeHandle | ModifierVolumeHandle | |
    |
float | Radius | Local space volume radius (diameter = Radius * 2 * ComponentScale3D). |
    |
EInstancedActorsVolumeShape | Shape | Volume bounds shape Note: Replicated only in the initial bunch |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UInstancedActorsModifierVolumeComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | OnAddedToManager
(
AInstancedActorsManager& Manager |
Called on addition to Manager in AInstancedActorsManager::AddModifierVolume. |
 |
void | OnAddedToSubsystem
(
UInstancedActorsSubsystem& InstancedActorSubsystem, |
Finds managers already registered with InInstancedActorSubsystem and adds this modifier to them. |
 |
void | OnRemovedFromManager
(
AInstancedActorsManager& Manager |
Called on removal from Manager in AInstancedActorsManager::RemoveModifierVolume. |
 |
bool | TryRunPendingModifiers
(
AInstancedActorsManager& Manager, |
Executes Modifiers for all instances in Manager overlapped by this volume. |
Overridden from UPrimitiveComponent
| Type | Name | Description | |
|---|---|---|---|
  |
FPrimitiveSceneProxy * | Creates a proxy to represent the primitive to the scene manager in the rendering thread. |
Overridden from USceneComponent
| Type | Name | Description | |
|---|---|---|---|
   |
FBoxSphereBounds | CalcBounds
(
const FTransform& LocalToWorld |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginPlay () |
Used to detach physics objects before simulation begins. |
  |
void | EndPlay
(
EEndPlayReason::Type Reason |
Ends gameplay for this component. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
   |
void | GetLifetimeReplicatedProps
(
TArray< FLifetimeProperty >& OutLifetimeProps |
Returns properties that are replicated for the lifetime of the actor channel |