Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Foliage > AInstancedFoliageActor

Light Theme

Dark Theme

AInstancedFoliageActor

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

APartitionActor

AISMPartitionActor

AInstancedFoliageActor

References

Module	Foliage
Header	/Engine/Source/Runtime/Foliage/Public/InstancedFoliageActor.h
Include	#include "InstancedFoliageActor.h"

Syntax

class AInstancedFoliageActor : public AISMPartitionActor

Variables

		Name	Description
	FFoliageInstanc...	InstanceBaseCache	Cross level references cache for instances base.

Constructors

	Name	Description
	AInstancedFoliageActor ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
TUniqueObj< ...	AddFoliageInfo ( UFoliageType* FoliageType )
TUniqueObj< ...	AddFoliageInfo ( UFoliageType* FoliageType, TUniqueObj< FFoliageInfo >&& Folia... )
UFoliageType...	AddFoliageType ( const UFoliageType* InType, FFoliageInfo** OutInfo )
void	AddInstances ( UObject* WorldContextObject, UFoliageType* InFoliageType, const TArray< FTransform >& InTran... )
FFoliageInfo...	AddMesh ( UStaticMesh* InMesh, UFoliageType** OutSettings, const UFoliageType_InstancedStaticM... )	Add a new static mesh.
FFoliageInfo...	AddMesh ( UFoliageType* InType )	Add a new static mesh.
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	ApplySelection ( bool bApply )	Propagate the selected instances to the actual foliage implementation.
bool	CanEditFoliageInstance ( const FFoliageInstanceId& Instance... )
bool	CanMoveFoliageInstance ( const FFoliageInstanceId& Instance..., const ETypedElementWorldType WorldT... )
bool	CheckCollisionWithWorld ( const UWorld* InWorld, const UFoliageType* Settings, const FFoliageInstance& Inst, const FVector& HitNormal, const FVector& HitLocation, UPrimitiveComponent* HitCompon... )
void	CleanupDeletedFoliageType()
bool	ContainsInstancesFromProceduralFoliageComponent ( const UProceduralFoliageComponent&... )
bool	DeleteFoliageInstances ( TArrayView< const FFoliageInstanceI... )
void	DeleteInstancesForComponent ( UActorComponent* InComponent )	Deletes the instances attached to a component.
void	DeleteInstancesForComponent ( UWorld* InWorld, UActorComponent* InComponent )	Deletes the instances attached to a component, traverses all foliage actors in the world.
void	DeleteInstancesForComponent ( UActorComponent* InComponent, const UFoliageType* InFoliageT... )	Deletes the instances attached to a component.
void	DeleteInstancesForProceduralFoliageComponent ( const UProceduralFoliageComponent&..., bool InRebuildTree )	Deletes the instances spawned by a procedural component.
void	DetectFoliageTypeChangeAndUpdate()
bool	DuplicateFoliageInstances ( TArrayView< const FFoliageInstanceI..., TArray< FFoliageInstanceId >& OutN... )
void	EnterEditMode()
void	ExitEditMode()
const UFolia...	FindFoliageType ( const FFoliageInfo* InFoliageI... )	Returns FoliageType associated to this FoliageInfo.
FFoliageInfo...	FindFoliageTypeOfClass ( TSubclassOf< UFoliageType_Instanced... )
FFoliageInfo...	FindInfo ( const UFoliageType* InType )	Finds a mesh entry.
const FFolia...	FindInfo ( const UFoliageType* InType )	Finds a mesh entry.
FFoliageInfo...	FindOrAddMesh ( UFoliageType* InType )	Finds a mesh entry or adds it if it doesn't already exist.
bool	FoliageTrace ( const UWorld* InWorld, FHitResult& OutHit, const FDesiredFoliageInstance& Des..., FName InTraceTag, bool InbReturnFaceIndex, const FFoliageTraceFilterFunc& Fil..., bool bAverageNormal )
void	ForEachFoliageInfo ( TFunctionRef< bool... )
AInstancedFo...	Get ( UWorld* InWorld, bool bCreateIfNone, ULevel* InLevelHint, const FVector& InLocationHint )	Get the instanced foliage actor for the specified params
void	GetAllFoliageTypesForSource ( const UObject* InSource, TArray< const UFoliageType* > ... )	Performs a reverse lookup from a source object to all the foliage types that are currently using that object (includes assets and blueprint classes)
TMap< UFolia...	GetAllInstancesFoliageType()	Will return all the foliage type used.
UActorCompon...	GetBaseComponentFromBaseId ( const FFoliageInstanceBaseId& Base... )
AInstancedFo...	GetDefault ( UWorld* InWorld )
const TMap< ...	GetFoliageInfos()
bool	GetFoliageInstanceTransform ( const FFoliageInstanceId& Instance..., FTransform& OutInstanceTransform, bool bWorldSpace )
UFoliageType...	GetFoliageTypeForInfo ( const FFoliageInfo* FoliageInf... )
AInstancedFo...	GetInstancedFoliageActorForCurrentLevel ( const UWorld* InWorld, bool bCreateIfNone )	Get the instanced foliage actor for the current streaming level.
AInstancedFo...	GetInstancedFoliageActorForLevel ( ULevel* Level, bool bCreateIfNone )	Get the instanced foliage actor for the specified streaming level.
TMap< UFolia...	GetInstancesForComponent ( UActorComponent* InComponent )	Returns a map of Static Meshes and their placed instances attached to a component.
UFoliageType...	GetLocalFoliageTypeForSource ( const UObject* InSource, FFoliageInfo** OutMeshInfo )	Performs a reverse lookup from a source object to a local foliage type (i.e. the foliage type owned exclusively by this IFA)
int32	GetOverlappingBoxCount ( const UFoliageType* FoliageTyp..., const FBox& Box )	Finds the number of instances overlapping with the box.
void	GetOverlappingBoxTransforms ( const UFoliageType* FoliageTyp..., const FBox& Box, TArray< FTransform >& OutTransform... )	Finds all instances in the provided box and get their transforms.
void	GetOverlappingMeshCounts ( const FSphere& Sphere, TMap< UStaticMesh*, int32 >& ... )	Perf Warnin: potentially slow! Dev-only use recommended.
int32	GetOverlappingSphereCount ( const UFoliageType* FoliageTyp..., const FSphere& Sphere )	Finds the number of instances overlapping with the sphere.
TMap< UFolia...	GetSelectedInstancesFoliageType()	Will return all the foliage type used by currently selected instances.
FBox	GetSelectionBoundingBox()	Get the bounds of all selected instances.
bool	GetSelectionLocation ( FBox& OutLocation )	Returns the location for the widget.
void	HandleFoliageInstancePostMove ( const FFoliageInstanceId& Instance... )
void	HandleFoliageInstancePreMove ( const FFoliageInstanceId& Instance... )
bool	HasFoliageAttached ( UActorComponent* InComponent )	Whether there any foliage instances painted on specified component
bool	HasSelectedInstances()	Whether actor has selected instances.
void	MapRebuild()	Called in response to BSP rebuilds to migrate foliage from obsolete to new components.
void	MoveAllInstancesToLevel ( ULevel* InTargetLevel )	Move all instances to a foliage actor in target level.
void	MoveInstancesForComponentToCurrentLevel ( UActorComponent* InComponent )	Moves instances based on the specified component to the current streaming level.
void	MoveInstancesForComponentToLevel ( UActorComponent* InComponent, ULevel* TargetLevel )
void	MoveInstancesForMovedComponent ( UActorComponent* InComponent )	Move instances based on a component that has just been moved.
void	MoveInstancesForMovedOwnedActors ( AActor* InActor )	Move instances that are owned by foliage actor.
void	MoveInstancesToLevel ( ULevel* InTargetLevel, TSet< int32 >& InInstanceList, FFoliageInfo* InCurrentMeshInf..., UFoliageType* InFoliageType, bool bSelect )	Move instances to a foliage actor in target level.
void	MoveInstancesToNewComponent ( UPrimitiveComponent* InOldComp..., UPrimitiveComponent* InNewComp... )	Change all instances based on one component to a new component (possible in another level).
void	MoveInstancesToNewComponent ( UPrimitiveComponent* InOldComp..., const FBox& InBoxWithInstancesToMo..., UPrimitiveComponent* InNewComp... )	Change all instances based on one component to a new component (possible in another level).
void	MoveInstancesToNewComponent ( UWorld* InWorld, UPrimitiveComponent* InOldComp..., UPrimitiveComponent* InNewComp... )	Change all instances based on one component to a new component (possible in another level).
void	MoveInstancesToNewComponent ( UWorld* InWorld, UPrimitiveComponent* InOldComp..., const FBox& InBoxWithInstancesToMo..., UPrimitiveComponent* InNewComp... )	Change all instances based on one component to a new component (possible in another level).
void	MoveSelectedInstancesToLevel ( ULevel* InTargetLevel )	Move selected instances to a foliage actor in target level.
void	NotifyFoliageInstanceMovementEnded ( const FFoliageInstanceId& Instance... )
void	NotifyFoliageInstanceMovementOngoing ( const FFoliageInstanceId& Instance... )
void	NotifyFoliageInstanceMovementStarted ( const FFoliageInstanceId& Instance... )
void	NotifyFoliageInstanceSelectionChanged ( const FFoliageInstanceId& Instance..., const bool bIsSelected )
void	NotifyFoliageTypeChanged ( UFoliageType* FoliageType, bool bSourceChanged )	Called to notify InstancedFoliageActor that a UFoliageType has been modified
void	NotifyFoliageTypeWillChange ( UFoliageType* FoliageType )
FOnFoliageTy...	OnFoliageTypeMeshChanged()
void	RemoveAllInstances ( UObject* WorldContextObject, UFoliageType* InFoliageType )
void	RemoveBaseComponentOnFoliageTypeInstances ( UFoliageType* FoliageType )
bool	RemoveFoliageInfoAndCopyValue ( UFoliageType* FoliageType, TUniqueObj< FFoliageInfo >& OutFol... )
void	RemoveFoliageType ( UFoliageType** InFoliageTy..., int32 Num )	Remove the FoliageType from the list, and all its instances.
void	RepairDuplicateIFA ( AInstancedFoliageActor* InDupl... )	Fix up a duplicate IFA
void	SelectInstance ( UInstancedStaticMeshComponent*..., int32 InComponentInstanceIndex, bool bToggle )	Select an individual instance.
bool	SelectInstance ( AActor* InActor, bool bToggle )	Select an individual instance.
bool	SetFoliageInstanceTransform ( const FFoliageInstanceId& Instance..., const FTransform& InstanceTransfor..., bool bWorldSpace, bool bTeleport )

Overridden from APartitionActor

		Name	Description
	uint32	GetDefaultGridSize ( UWorld* InWorld )
	bool	ShouldIncludeGridSizeInName ( UWorld* InWorld )

Overridden from AActor

	Name	Description
void	Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
float	InternalTakeRadialDamage ( float Damage, FRadialDamageEvent const& RadialDa..., AController* EventInstigator, AActor* DamageCauser )	Default InternalTakeRadialDamage behavior finds and scales damage for the closest component which isn't appropriate for foliage.
bool	IsLevelBoundsRelevant()	Indicates whether this actor should participate in level bounds calculations
void	RerunConstructionScripts()	We don't want to have our components automatically destroyed by the Blueprint code
bool	ShouldExport()	Called before editor copy, true allow export
bool	ShouldImport ( FString* ActorPropString, bool IsMovingLevel )	Called before editor paste, true allow import

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditUndo()	Called before applying a transaction to the object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from ISMInstanceManagerProvider

		Name	Description
	ISMInstanceM...	GetSMInstanceManager ( const FSMInstanceId& InstanceId )	Attempt to get the instance manager associated with the given static mesh instance, if any.

Classes

	Name	Description
	FOnFoliageTypeMeshChanged

Typedefs

Name	Description
FOnInstanceCoundChanged
FOnSelectionChanged	Delegate type for selection change events.

Constants

Name	Description
InstanceCountChanged
SelectionChanged