1. Epic GamesDeveloper
  3. FInstancedActorsSettings

FInstancedActorsSettings

Settings for controlling Instanced Actor behavior.

API > API/Plugins > API/Plugins/InstancedActors

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.

   
Name FInstancedActorsSettings
Type struct
Header File /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/Public/InstancedActorsSettingsTypes.h
Include Path #include "InstancedActorsSettingsTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FInstancedActorsSettings : public FTableRowBase

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
DefaultMaxInstanceDistance double   InstancedActorsSettingsTypes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActorClass TSubclassOf< AActor > Wholesale replace this type of entity with this actor instead. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_ActorClass")
  • Category=InstancedActors
ActorEjectionMovementThreshold float 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. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • Meta=(EditCondition="bOverride_ActorEjectionMovementThreshold")
  • Category=InstancedActors
AffectDistanceFieldLighting TArray< bool > If enabled, then asset will be used in distance field lighting InstancedActorsSettingsTypes.h
  • EditAnywhere
  • EditFixedSize
  • Meta=(EditFixedOrder, EditCondition="bOverride_AffectDistanceFieldLighting")
  • Category=InstancedActors
AppliedSettingsOverrides TArray< FName > Note: Don't forget to implement overriding for new settings in ApplyOverrides and Stringification in ToString. InstancedActorsSettingsTypes.h
  • VisibleAnywhere
  • Category=InstancedActors
bCanBeDamaged bool Turn on or off damage. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_bCanBeDamaged")
  • Category=InstancedActors
bCanEverAffectNavigation bool Can this object ever affect the navigation graph generation for AI etc. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_bCanEverAffectNavigation")
  • Category=InstancedActors
bControlPhysicsState bool If false, collision will not be managed by the mass LODs for this instance InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_bControlPhysicsState")
  • Category=InstancedActors
bDisableAutoDistanceCulling bool Disable auto computed distance culling using the bounding box of the static mesh - instance will render upto MaxInstanceDistance InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_bDisableAutoDistanceCulling")
  • Category=InstancedActors
bEjectOnActorMoved bool 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. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • Meta=(EditCondition="bOverride_bEjectOnActorMoved")
  • Category=InstancedActors
bIgnoreModifierVolumes bool Completely disable modifier volumes for this type of instance. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_bIgnoreModifierVolumes")
  • Category=InstancedActors
bInstancesCastShadows bool Optional shadow casting override applied to instance ISMC's if set (shadow casting settings from ActorClass will be used for ISMC's if unset) InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_bInstancesCastShadows")
  • Category=InstancedActors
bModifierVolumeCheckFullyEnclosed bool By default, modifier volumes will do a bounds intersection test against instances. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_bModifierVolumeCheckFullyEnclosed")
  • Category=InstancedActors
bOverride_ActorClass uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_ActorEjectionMovementThreshold uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_AffectDistanceFieldLighting uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bCanBeDamaged uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bCanEverAffectNavigation uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bControlPhysicsState uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bDisableAutoDistanceCulling uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bEjectOnActorMoved uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bIgnoreModifierVolumes uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bInstancesCastShadows uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_bModifierVolumeCheckFullyEnclosed uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_DetailedRepresentationLODDistance uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_ForceLowRepresentationLODDistance uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_GameplayTags uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_LODDistanceScales uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_MaxActorDistance uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_MaxInstanceDistances uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_OverrideWorldPartitionGrid uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_ScaleEntityCount uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
bOverride_WorldPositionOffsetDisableDistance uint8   InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(InlineEditConditionToggle)
  • Category=InstancedActors
DetailedRepresentationLODDistance double Perform per-entity 'detailed' representation LOD calculation up to this distance from a viewer InstancedActorsSettingsTypes.h
  • EditAnywhere
  • Meta=(EditCondition="bOverride_DetailedRepresentationLODDistance")
  • Category=InstancedActors
ForceLowRepresentationLODDistance double Force 'Low' representation LOD for all entities further than this distance from a viewer InstancedActorsSettingsTypes.h
  • EditAnywhere
  • Meta=(EditCondition="bOverride_ForceLowRepresentationLODDistance")
  • Category=InstancedActors
GameplayTags FGameplayTagContainer Gameplay Tags that can be used in Modifier queries InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_GameplayTags")
  • Category=InstancedActors
LODDistanceScales TArray< float > Sets LOD Distance Scale for low quality level, see IA.ViewDistanceQuality InstancedActorsSettingsTypes.h
  • EditAnywhere
  • EditFixedSize
  • Meta=(EditFixedOrder, EditCondition="bOverride_LODDistanceScales")
  • Category=InstancedActors
MaxActorDistance double Distance in cm from player to spawn actors within. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • Meta=(EditCondition="bOverride_MaxActorDistance")
  • Category=InstancedActors
MaxInstanceDistances TArray< double > Scale applied on MaxDrawDistance for low quality level, see IA.ViewDistanceQuality InstancedActorsSettingsTypes.h
  • EditAnywhere
  • EditFixedSize
  • Meta=(EditFixedOrder, EditCondition="bOverride_MaxInstanceDistances")
  • Category=InstancedActors
ObjectClassVersion uint8   InstancedActorsSettingsTypes.h  
OverrideWorldPartitionGrid FName What world partition grid should this instance be placed into. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_OverrideWorldPartitionGrid")
  • Category=InstancedActors
ScaleEntityCount float Scale the number of entities spawned. It must be between 0.0 and 1.0, for 0% and 100% respectively. InstancedActorsSettingsTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(EditCondition="bOverride_ScaleEntityCount", ClampMin="0.0", ClampMax="1.0", UIMin="0.8", UIMax="1.0")
  • Category=InstancedActors
WorldPositionOffsetDisableDistance int32 Distance in cm from which WPO is disabled InstancedActorsSettingsTypes.h
  • EditAnywhere
  • Meta=(EditCondition="bOverride_WorldPositionOffsetDisableDistance")
  • Category=InstancedActors

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   InstancedActorsSettingsTypes.h  

virtual FString DebugToString ( bool bOverridesOnly
) const

   InstancedActorsSettingsTypes.h  

bool GetAffectDistanceFieldLighting()

   InstancedActorsSettingsTypes.h  

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. InstancedActorsSettingsTypes.h  

virtual void PostSerialize ( const FArchive& Ar
)

 Sets up the cached tag containers InstancedActorsSettingsTypes.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bOverride_MaxInstanceDistance_DEPRECATED uint8   InstancedActorsSettingsTypes.h
  • Meta=(DeprecatedProperty)
  • Transient
MaxInstanceDistance_DEPRECATED double Final draw distance for ISMC instances InstancedActorsSettingsTypes.h
  • Meta=(DeprecatedProperty)
  • Transient

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page