unreal.FoliageStatistics

class unreal.FoliageStatistics(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Foliage Statistics

C++ Source:

  • Module: Foliage

  • File: FoliageStatistics.h

classmethod foliage_overlapping_box_count(world_context_object, static_mesh, box) int32

Gets the number of instances overlapping a provided box

Parameters:
  • world_context_object (Object) –

  • static_mesh (StaticMesh) – Mesh to count

  • box (Box) – Box to overlap

Return type:

int32

classmethod foliage_overlapping_box_transforms(world_context_object, static_mesh, box) Array[Transform]

Get the transform of every instance overlapping the provided FBox

Parameters:
  • world_context_object (Object) –

  • static_mesh (StaticMesh) – Mesh to get instances of

  • box (Box) – Box to use for overlap

Returns:

out_transforms (Array[Transform]): Array to populate with transforms

Return type:

Array[Transform]

classmethod foliage_overlapping_sphere_count(world_context_object, static_mesh, center_position, radius) int32

Counts how many foliage instances overlap a given sphere

Parameters:
  • world_context_object (Object) –

  • static_mesh (StaticMesh) –

  • center_position (Vector) – The center position of the sphere

  • radius (float) – The radius of the sphere. return number of foliage instances with their mesh set to Mesh that overlap the sphere

Return type:

int32