1. Epic GamesDeveloper
  3. FInstancedActorsSettings

FInstancedActorsSettings

Settings for controlling Instanced Actor behavior.

API > API/Plugins > API/Plugins/InstancedActors

Inheritance Hierarchy

References

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

Syntax

USTRUCT (BlueprintType )  
struct FInstancedActorsSettings : public FTableRowBase

Remarks

Settings for controlling Instanced Actor behavior. Applied by 'actor class' either in groups via 'named settings' e.g: "SmallThings", "Trees" or on a specific class basis.

Named settings are FInstancedActorsSettings registered by name in UInstancedActorsProjectSettings::NamedSettingsRegistryType data registry.

Class-specific settings are FInstancedActorsSettings registered by actor class via FInstancedActorsClassSettingsBase's in the UInstancedActorsProjectSettings::ActorClassSettingsRegistryType data registry. Named settings can be used as bases here via FInstancedActorsClassSettingsBase::BaseSettings.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TSubclassOf< AActor > ActorClass Wholesale replace this type of entity with this actor instead.
Public variable UProperty Category, EditAnywhere, Meta float ActorEjectionMovementThreshold If bEjectOnActorMoved = true, spawned Actors will have their locations monitored and if moved further than ActorEjectionMovementThreshold from their spawn location, they will be 'ejected' from their manager / marked as destroyed and transferred to persistence system.
Public variable UProperty Category, EditAnywhere, Meta editfixedsize TArray< bool > AffectDistanceFieldLighting If enabled, then asset will be used in distance field lighting
Public variable UProperty Category visibleanywhere TArray< FName > AppliedSettingsOverrides Note: Don't forget to implement overriding for new settings in ApplyOverrides and Stringification in ToString.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bCanBeDamaged Turn on or off damage.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bCanEverAffectNavigation Can this object ever affect the navigation graph generation for AI etc.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bControlPhysicsState Fix for PLAY-11011. If false, collision will not be managed by the mass LODs for this instance
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bDisableAutoDistanceCulling Disable auto computed distance culling using the bounding box of the static mesh - instance will render upto MaxInstanceDistance
Public variable UProperty Category, EditAnywhere, Meta bool bEjectOnActorMoved If bEjectOnActorMoved = true, spawned Actors will have their locations monitored and if moved further than ActorEjectionMovementThreshold from their spawn location, they will be 'ejected' from their manager / marked as destroyed and transferred to persistence system.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bIgnoreModifierVolumes Completely disable modifier volumes for this type of instance.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bInstancesCastShadows Optional shadow casting override applied to instance ISMC's if set (shadow casting settings from ActorClass will be used for ISMC's if unset)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_ActorClass  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_ActorEjectionMovementThreshold  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_AffectDistanceFieldLighting  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_bCanBeDamaged  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_bCanEverAffectNavigation  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_bControlPhysicsState  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_bDisableAutoDistanceCulling  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_bEjectOnActorMoved  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_bIgnoreModifierVolumes  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_bInstancesCastShadows  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_DetailedRepresentationLODDistance  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_ForceLowRepresentationLODDistance  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_LODDistanceScales  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_MaxActorDistance  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_MaxInstanceDistances  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_OverrideWorldPartitionGrid  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_ScaleEntityCount  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = false bOverride_WorldPositionOffsetDisableDistance  
Public variable UProperty Category, EditAnywhere, Meta double DetailedRepresentationLODDistance Perform per-entity 'detailed' representation LOD calculation up to this distance from a viewer
Public variable UProperty Category, EditAnywhere, Meta double ForceLowRepresentationLODDistance Force 'Low' representation LOD for all entities further than this distance from a viewer
Public variable UProperty Category, EditAnywhere, Meta editfixedsize TArray< float > LODDistanceScales Sets LOD Distance Scale for low quality level, see IA.ViewDistanceQuality
Public variable UProperty Category, EditAnywhere, Meta double MaxActorDistance Distance in cm from player to spawn actors within.
Public variable UProperty Category, EditAnywhere, Meta editfixedsize TArray< double > MaxInstanceDistances Scale applied on MaxDrawDistance for low quality level, see IA.ViewDistanceQuality
Public variable UProperty uint8 ObjectClassVersion  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName OverrideWorldPartitionGrid What world partition grid should this instance be placed into.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float ScaleEntityCount Scale the number of entities spawned. It must be between 0.0 and 1.0, for 0% and 100% respectively.
Public variable UProperty Category, EditAnywhere, Meta int32 WorldPositionOffsetDisableDistance Distance in cm from which WPO is disabled

Functions

  Type Name Description
Public function Const void

ComputeLODDistanceData ( double& OutMaxInstanceDistance,
double& MaxDrawDistanceScale,
float& OutLODDistanceScale
)

  
Public function Virtual Const FString

DebugToString ( bool bOverridesOnly
)

  
Public function Const bool  
Public function Virtual void

OverrideIfDefault ( FConstStructView OverrideSettings,
const FName& OverrideSettingsName
)

 Apply OverrideSettings to settings not already overridden Note: This is designed for applying settings in reverse order i.e: applying highest priority settings first.
Public function Virtual void

PostSerialize ( const FArchive& Ar
)

 Sets up the cached tag containers

Constants

Name Description
DefaultMaxInstanceDistance  

Deprecated Variables

  Type Name Description
Public variable UProperty Meta Transient uint8: 1 = false bOverride_MaxInstanceDistance_DEPRECATED  
Public variable UProperty Meta Transient double MaxInstanceDistance_DEPRECATED Final draw distance for ISMC instances

See Also

UInstancedActorsProjectSettingsfor settings registry info.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page