foliage kit

184 tools. Generated from the plugin source; do not edit by hand.

Guide

The foliage kit manages foliage type assets, the instances of the current editor level, headless surface placement, procedural foliage volumes and folder-wide audits. Everything goes through the public Foliage runtime APIs (AInstancedFoliageActor, FFoliageInfo, UProceduralFoliageComponent); the editor's paint brushes live in the private FoliageEdit module and are replaced by the trace-based tools below. Instance tools work on the current level's instanced foliage actor.

1. Types

• foliage.create_type (static mesh) / create_actor_type (actor class) create the asset; duplicate_type, rename_type, delete_type, save_type, list_types, get_type.
• Typed setters, all returning the stored values: placement (set_density, set_radius, set_z_offset, set_align_to_normal, set_align_max_angle, set_random_yaw, set_random_pitch, set_average_normal 5.0+), filters (set_ground_slope_filter, set_height_filter, set_type_filters for landscape layers), scaling (set_type_scaling), culling and scalability (set_cull_distance, set_scalability, set_cull_distance_scaling 5.2+), rendering (set_mobility, set_lighting_channels, set_custom_depth, set_translucency_sort_priority, set_lightmap_resolution, shadows incl. set_shadow_two_sided, set_contact_shadow 5.0+, set_shadow_cache_invalidation 5.3+, set_visible_in_ray_tracing, set_wpo_disable_distance 5.1+, set_virtual_texture), collision (set_collision_enabled, set_collision_profile, set_collision_scale), mesh (set_mesh, set_material_override, set_nanite_material_override 5.1+, set_component_class), procedural growth (set_collision_radius, set_shade_radius, set_num_steps, set_seeds_per_step, set_shade_growth, set_procedural_distribution, ...) and actor foliage (set_actor_type_settings).
• Readbacks: get_placement, get_scaling, get_culling, get_lighting, get_collision, get_procedural_settings, get_rendering. set_type remains for a reviewed property without a typed tool; an unknown property is an error.

2. Level instances

• Register with add_type_to_level (optional, insertion registers automatically), inspect with list_level_types, count, get_bounds.
• Explicit placement: add_instances / add_instance with transforms; scatter_grid and scatter_random place at a fixed z without tracing.
• Query: get_instances, get_instance, nearest_instance, get_instances_in_box, get_instances_in_sphere, find_instances (box AND sphere AND z range AND scale range).
• Edit: set_instance_transform (one transform, many indices), set_instance_transforms (one per index), move_instances, scale_instances, rotate_instances, transform_region (every instance in a box), randomize_instances (seeded yaw/uniform scale), duplicate_instances, move_instances_to_type, replace_type (all instances to another type).
• Remove: remove_indices, remove_in_box, remove_in_sphere, remove_filtered, remove_by_type; foliage.remove_all clears every type of the current level (or all levels).
• Selection: select_instances, clear_selection, get_selected_instances.
• Custom data: set_custom_data_channels (5.3+), set_custom_data (5.0+), get_custom_data. Custom data lives on the foliage component and is rebuilt when the type changes; re-apply it after type edits.
• Files: export_instances writes Saved/UEAMCP/Foliage/<file>.json (layout x,y,z,pitch,yaw,roll,scaleX,scaleY,scaleZ per type); import_instances validates the whole file first, then inserts (replace:true clears each target type first, type redirects every record).

3. Headless placement (tracing)

paint_circle, paint_box, paint_line, paint_actor and scatter_poisson sample points, trace down with AInstancedFoliageActor::FoliageTrace (same hit rules as the editor: no volumes, no hidden actors, no NoCollision components, never on the same type), then apply the type's slope, height and landscape-layer filters, build the instance with a seeded version of the editor's manual placement (scale mode and ranges, z offset, random yaw/pitch, align to normal), run the world-collision test when CollisionWithWorld is set, reject samples closer than the type radius, and insert with FFoliageInfo::AddInstance on the hit component (instances follow their base).

• count fixes the sample count; count:0 derives it from the type density (instances per 1000x1000 cm).
• The reply reports attempts, placed, noHit, slope, height, layer, collision, overlap; dryRun:true reports without inserting. Use preview_trace to see what one sample would hit and which filter rejects it.
• paint_actor only accepts hits on the named actor (exact label). scatter_poisson uses Bridson sampling with minDistance; trace:false inserts at min.z without filters.
• Follow-ups: snap_to_ground (drop instances onto the surface, optional normal alignment), reapply_settings (re-roll scale/yaw/pitch from the type's current ranges), thin_instances (greedy spacing enforcement, dryRun available).
• create_ground spawns (or reuses by label) a 10 cm collision slab from /Engine/BasicShapes/Cube when a blockout needs a surface.

Recipe: forest floor on a landscape layer

1. foliage.create_type → set_type_filters {landscapeLayers:['Grass'], minimumLayerWeight:'0.5'} → set_ground_slope_filter {min:0,max:30}.
2. foliage.paint_box {min,max, count:0, seed:1, dryRun:true} and read the rejection counters.
3. Run it again without dryRun; foliage.thin_instances if the radius was raised afterwards.

4. Procedural foliage

• Spawner assets: create_spawner, get_spawner, set_spawner, set_spawner_seed, set_spawner_tile_size, set_spawner_unique_tiles, validate_spawner, list_spawners, add_spawner_type, remove_spawner_type, list_spawner_types. The type's own procedural fields (collision/shade radius, steps, seeds, spread, ages, overlap priority) drive the growth.
• Volumes: add_volume (box brush + spawner), set_volume (spawner, location, extent, tile overlap), set_volume_filters (landscape/BSP/static mesh/translucent/foliage surfaces), get_volume, list_volumes, add_blocking_volume, remove_volume (also clears its instances).
• simulate runs UProceduralFoliageComponent::GenerateProceduralContent, removes the volume's previous instances, traces every desired instance with the volume's surface flags, applies the type filters and inserts through FPotentialInstance::PlaceInstance + FFoliageInfo, stamping the volume's procedural GUID. resimulate_all does it for every volume; volume_stats counts the stamped instances per type; clear_volume removes them. Simulation shows the engine's progress slow task while it waits for the tile workers. Same spawner seed + same surfaces = same result.

5. Audits and batches

• audit, validate, stats, find_types_by_mesh, audit_density, audit_cull_distance, audit_shadows, audit_collision, find_unused_types: per-type items with warning, value and world instance counts.
• batch_set_* (cull distance, shadows, collision profile, density, radius, mobility, scale, ...) and replace_type_mesh accept dryRun:true and report before -> after per type.
• Level hygiene: list_foliage_actors, cleanup_invalid (non-finite or non-positive-scale instances and registrations of deleted type assets), remove_unused_level_types, rebuild_all (cluster rebuild), move_to_level (current level → another loaded level; same level is a reported no-op), to_static_mesh_actors / from_static_mesh_actors (the actor mesh must equal the type mesh).

Gates

• 5.0+: set_average_normal, set_contact_shadow, set_include_in_hlod, batch_set_hlod, batch_set_contact_shadow, set_custom_data; 5.1+: set_wpo_disable_distance, set_nanite_material_override; 5.2+: set_cull_distance_scaling; 5.3+: set_shadow_cache_invalidation, set_custom_data_channels. set_actor_type_settings rejects staticMeshOnly:true on 4.27.
• Not available: the interactive paint/erase/lasso brushes of the Foliage editor mode (FoliageEdit is private). The tools above cover the same outcomes headlessly.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

foliage.add_blocking_volume (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
label	string	required. Actor label (must be unused).
volume	string	Procedural volume it blocks; empty blocks every procedural volume.
location	{x,y,z}	Volume centre.
extent	{x,y,z}	Box half size (cm). Default FUeaVec3(200,200,500).

Returns: volume.

foliage.add_instance (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
transforms	array of UeaFoliageTransform	required.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.add_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
transforms	array of UeaFoliageTransform	required.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.add_spawner_type (risk 2, mutates, smoke)

No description.

Argument	Type	Description
spawner	string	required. Procedural foliage spawner asset.
type	string	required. Foliage type asset.

Returns: spawner.

foliage.add_type_to_level (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: types, count.

foliage.add_volume (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
label	string	required. Actor label (must be unused).
spawner	string	required. Procedural foliage spawner asset.
location	{x,y,z}	Volume centre.
extent	{x,y,z}	Box half size (cm). Default FUeaVec3(1000,1000,500).
tileOverlap	number	Overlap between simulation tiles (cm). Default 0.

Returns: volume.

foliage.audit (risk 0, smoke)

No description.

Argument	Type	Description
folder	string	Default TEXT("/Game").

Returns: items, count, changed, warnings, dryRun.

foliage.audit_collision (risk 0, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
minInstances	integer	Only flag types with at least this many instances in the editor world. Default 0.

Returns: items, count, changed, warnings, dryRun.

foliage.audit_cull_distance (risk 0, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
maxEndDistance	integer	Flag end distances above this value (0 flags only never-culled types). Default 0.

Returns: items, count, changed, warnings, dryRun.

foliage.audit_density (risk 0, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
maxDensity	number	Density (instances per 1000x1000 cm) above which a type is flagged. Default 100.

Returns: items, count, changed, warnings, dryRun.

foliage.audit_shadows (risk 0, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
minInstances	integer	Only flag types with at least this many instances in the editor world. Default 0.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_align_to_normal (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_collision (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
profile	string	required. Collision profile name.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_contact_shadow (risk 2, mutates, UE 5.0+, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_cull_distance (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
startDistance	integer	Cull start distance (cm). Default 0.
endDistance	integer	Cull end distance (cm). Default 10000.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_decals (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_density (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	number	Value applied to every matching foliage type. Default 0.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_density_scaling (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_distance_field (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_dynamic_shadow (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_hlod (risk 2, mutates, UE 5.0+, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_indirect_lighting (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_mobility (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
mobility	string	required. Static, Stationary or Movable.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_occluder (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_radius (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	number	Value applied to every matching foliage type. Default 0.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_random_yaw (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_scale (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
min	number	Minimum uniform scale. Default 1.
max	number	Maximum uniform scale. Default 1.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_shadows (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_static_shadow (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.batch_set_wpo (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
value	boolean	Value applied to every type. Default true.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.cleanup_invalid (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
allLevels	boolean	Every loaded level instead of only the current level. Default false.
dryRun	boolean	Report without applying (clean-up tools). Default false.

Returns: types, actors, removed, deletedTypes, dryRun.

foliage.clear_selection (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
offset	integer	Default 0.
limit	integer	Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.clear_volume (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
volume	string	required. Exact label of a ProceduralFoliageVolume.

Returns: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.

foliage.count (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
offset	integer	Default 0.
limit	integer	Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.create_actor_type (risk 2, mutates, smoke)

No description.

Argument	Type	Description
folder	string	required.
name	string	required.
actorClass	string	required.

Returns: type.

foliage.create_ground (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
label	string	Actor label; an existing static-mesh actor with this label is reused and resized. Default TEXT("FoliageGround").
center	{x,y,z}	World-space centre of the top surface.
extent	{x,y,z}	Half size in centimetres (x, y); z is ignored, the slab is 10 cm thick. Default FUeaVec3(1000,1000,0).

Returns: label, path, reused, boundsMin, boundsMax.

foliage.create_spawner (risk 2, mutates, smoke)

No description.

Argument	Type	Description
folder	string	required.
name	string	required.
randomSeed	integer	Default 0.
tileSize	number	Default 10000.
numUniqueTiles	integer	Default 1.

Returns: spawner.

foliage.create_type (risk 2, mutates, smoke)

No description.

Argument	Type	Description
folder	string	required.
name	string	required.
mesh	string	required.

Returns: type.

foliage.delete_type (risk 3, mutates, destructive, smoke)

No description.

Argument	Type	Description
type	string	required.

foliage.duplicate_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
indices	array of integer	required. Source instance indices.
offset	{x,y,z}	World offset of the copies.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.duplicate_type (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
folder	string	required.
name	string	required.

Returns: type.

foliage.export_instances (risk 1, requires world, smoke)

No description.

Argument	Type	Description
type	string	Registered foliage type; empty exports every type of the current level.
file	string	required. Bare file name (letters, digits, _ and -), without extension.

Returns: path, instances, types.

foliage.find_instances (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
inBox	boolean	Restrict to the min/max box. Default false.
min	{x,y,z}	Box minimum (with inBox).
max	{x,y,z}	Box maximum (with inBox).
center	{x,y,z}	Sphere centre (with radius > 0).
radius	number	Sphere radius in centimetres; 0 disables the sphere test. Default 0.
minZ	number	Minimum instance Z. Default -1.0e9.
maxZ	number	Maximum instance Z. Default 1.0e9.
minScale	number	Minimum of the largest scale axis. Default 0.
maxScale	number	Maximum of the largest scale axis. Default 1.0e9.
limit	integer	Maximum returned records. Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.find_types_by_mesh (risk 0, smoke)

No description.

Argument	Type	Description
mesh	string	required.
folder	string	Default TEXT("/Game").

Returns: items, count, changed, warnings, dryRun.

foliage.find_unused_types (risk 0, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Default TEXT("/Game").

Returns: items, count, changed, warnings, dryRun.

foliage.from_static_mesh_actors (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
actors	array of string	required. Exact labels of StaticMeshActors whose mesh equals the type mesh.
type	string	required. Instanced-static-mesh foliage type receiving the instances.
deleteActors	boolean	Delete the actors after conversion. Default false.

Returns: actors, count, removed, total.

foliage.get_bounds (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
offset	integer	Default 0.
limit	integer	Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.get_collision (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type, settings.

foliage.get_culling (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type, settings.

foliage.get_custom_data (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
index	integer	Default -1.

Returns: index, channels, values, component.

foliage.get_instance (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
index	integer	Default -1.

Returns: instance, count.

foliage.get_instances (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
offset	integer	Default 0.
limit	integer	Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.get_instances_in_box (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
min	{x,y,z}	World-space inclusive minimum bound.
max	{x,y,z}	World-space inclusive maximum bound.
limit	integer	Maximum returned records. Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.get_instances_in_sphere (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
center	{x,y,z}	World-space centre.
radius	number	Sphere radius in centimetres. Default 100.
limit	integer	Maximum returned records. Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.get_lighting (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type, settings.

foliage.get_placement (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type, settings.

foliage.get_procedural_settings (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type, settings.

foliage.get_rendering (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type, settings.

foliage.get_scaling (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type, settings.

foliage.get_selected_instances (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
offset	integer	Default 0.
limit	integer	Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.get_spawner (risk 0, smoke)

No description.

Argument	Type	Description
spawner	string	required.

Returns: spawner.

foliage.get_type (risk 0, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: type.

foliage.get_volume (risk 0, requires world, smoke)

No description.

Argument	Type	Description
volume	string	required. Exact label of a ProceduralFoliageVolume.

Returns: volume.

foliage.import_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
file	string	required. Bare file name written by foliage.export_instances.
type	string	Import every record into this type instead of the recorded ones.
replace	boolean	Remove the existing instances of each target type first. Default false.

Returns: path, instances, types.

foliage.list_foliage_actors (risk 0, requires world, smoke)

No description.

Argument	Type	Description
allLevels	boolean	Every loaded level instead of only the current level. Default false.
dryRun	boolean	Report without applying (clean-up tools). Default false.

Returns: actors, count, instances.

foliage.list_level_types (risk 0, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Default TEXT("/Game").
limit	integer	Default 100.

Returns: types, count.

foliage.list_spawner_types (risk 0, smoke)

No description.

Argument	Type	Description
spawner	string	required.

Returns: spawner.

foliage.list_spawners (risk 0, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan recursively. Default TEXT("/Game").

Returns: spawners, count.

foliage.list_types (risk 0, smoke)

No description.

Argument	Type	Description
folder	string	Default TEXT("/Game").
limit	integer	Default 100.

Returns: types, count.

foliage.list_volumes (risk 0, requires world, smoke)

No description.

Argument	Type	Description
includeBlocking	boolean	Include procedural blocking volumes. Default true.

Returns: volumes, count, removedInstances.

foliage.move_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
indices	array of integer	required.
offset	{x,y,z}

Returns: instances, count, total, boundsMin, boundsMax.

foliage.move_instances_to_type (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered source foliage type.
indices	array of integer	required. Instance indices.
targetType	string	required. Destination foliage type asset.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.move_to_level (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	Registered foliage type; empty moves every type.
indices	array of integer	Instance indices (with type); empty moves every instance.
level	string	required. Target level: "persistent", the package short name or the full package name of a loaded level.

Returns: sourceLevel, targetLevel, moved, note.

foliage.nearest_instance (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
location	{x,y,z}	required.

Returns: instance, count.

foliage.paint_actor (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
actor	string	required. Actor label or name whose surfaces receive instances.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.paint_box (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
min	{x,y,z}	Box minimum (x, y; z averaged with max as the trace mid-height).
max	{x,y,z}	Box maximum.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.paint_circle (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
center	{x,y,z}	Circle centre; z is the trace mid-height.
radius	number	Circle radius (cm). Default 500.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.paint_line (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
start	{x,y,z}	Segment start.
end	{x,y,z}	Segment end.
spacing	number	Distance between samples (cm). Default 100.
jitter	number	Random XY offset of each sample (cm). Default 0.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.preview_trace (risk 0, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type whose filters are evaluated.
location	{x,y,z}	Sample position; z is the trace mid-height.
traceHalfHeight	number	Trace half height (cm). Default 5000.

Returns: hit, location, normal, slopeDegrees, actor, component, landscape, rejection.

foliage.randomize_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
indices	array of integer	Instance indices; empty means every instance.
seed	integer	Random seed. Default 0.
randomYaw	boolean	Replace yaw with a random value. Default true.
scaleMin	number	Minimum uniform scale. Default 1.
scaleMax	number	Maximum uniform scale. Default 1.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.reapply_settings (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type.
indices	array of integer	Instance indices; empty means every instance.
seed	integer	Random seed. Default 0.
scale	boolean	Re-roll scale from the scaling mode and ranges. Default true.
yaw	boolean	Re-roll yaw (0..360). Default true.
pitch	boolean	Re-roll pitch within RandomPitchAngle. Default false.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.rebuild (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
offset	integer	Default 0.
limit	integer	Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.rebuild_all (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
allLevels	boolean	Every loaded level instead of only the current level. Default false.
dryRun	boolean	Report without applying (clean-up tools). Default false.

Returns: types, actors, removed, deletedTypes, dryRun.

foliage.remove_all (risk 3, mutates, destructive, requires world, dryRun, smoke)

No description.

Argument	Type	Description
allLevels	boolean	Every loaded level instead of only the current level. Default false.
dryRun	boolean	Report without applying (clean-up tools). Default false.

Returns: types, actors, removed, deletedTypes, dryRun.

foliage.remove_by_type (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
offset	integer	Default 0.
limit	integer	Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.remove_filtered (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
inBox	boolean	Restrict to the min/max box. Default false.
min	{x,y,z}	Box minimum (with inBox).
max	{x,y,z}	Box maximum (with inBox).
center	{x,y,z}	Sphere centre (with radius > 0).
radius	number	Sphere radius in centimetres; 0 disables the sphere test. Default 0.
minZ	number	Minimum instance Z. Default -1.0e9.
maxZ	number	Maximum instance Z. Default 1.0e9.
minScale	number	Minimum of the largest scale axis. Default 0.
maxScale	number	Maximum of the largest scale axis. Default 1.0e9.
limit	integer	Maximum returned records. Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.remove_in_box (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
min	{x,y,z}	World-space inclusive minimum bound.
max	{x,y,z}	World-space inclusive maximum bound.
limit	integer	Maximum returned records. Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.remove_in_sphere (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
center	{x,y,z}	World-space centre.
radius	number	Sphere radius in centimetres. Default 100.
limit	integer	Maximum returned records. Default 100.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.remove_indices (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
indices	array of integer	required.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.remove_spawner_type (risk 2, mutates, smoke)

No description.

Argument	Type	Description
spawner	string	required. Procedural foliage spawner asset.
type	string	required. Foliage type asset.

Returns: spawner.

foliage.remove_type_from_level (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.

Returns: types, count.

foliage.remove_unused_level_types (risk 3, mutates, destructive, requires world, dryRun, smoke)

No description.

Argument	Type	Description
dryRun	boolean	Report without applying. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.remove_volume (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
volumes	array of string	required. Exact labels of ProceduralFoliageVolume or ProceduralFoliageBlockingVolume actors.
clearInstances	boolean	Remove the instances spawned by each procedural volume first. Default true.

Returns: volumes, count, removedInstances.

foliage.rename_type (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
name	string	required.

Returns: type.

foliage.replace_type (risk 3, mutates, destructive, requires world, smoke)

No description.

Argument	Type	Description
sourceType	string	required. Existing registered foliage type.
targetType	string	required. Destination foliage type asset.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.replace_type_mesh (risk 2, mutates, dryRun, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to scan. Default TEXT("/Game").
fromMesh	string	required. Static mesh currently used by the types.
toMesh	string	required. Static mesh assigned instead.
dryRun	boolean	Report the per-type changes without applying them. Default false.

Returns: items, count, changed, warnings, dryRun.

foliage.resimulate_all (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
respectFilters	boolean	Apply the type slope, height and landscape-layer filters to the traced hits. Default true.
dryRun	boolean	Run the simulations and traces without replacing instances. Default false.

Returns: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.

foliage.rotate_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
indices	array of integer	required.
delta	{x,y,z}

Returns: instances, count, total, boundsMin, boundsMax.

foliage.save_type (risk 2)

No description.

Argument	Type	Description
type	string	required.

Returns: type.

foliage.scale_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
indices	array of integer	required.
multiplier	{x,y,z}	Default FUeaVec3(1,1,1).

Returns: instances, count, total, boundsMin, boundsMax.

foliage.scatter_grid (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
min	{x,y,z}	World-space minimum corner.
max	{x,y,z}	World-space maximum corner.
spacing	number	Grid spacing in centimetres. Default 100.
z	number	Placement height in centimetres. Default 0.
maxInstances	integer	Maximum instances to add. Default 1000.
seed	integer	Deterministic yaw seed. Default 0.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.scatter_poisson (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
min	{x,y,z}	Rectangle minimum.
max	{x,y,z}	Rectangle maximum.
minDistance	number	Minimum distance between samples (cm). Default 100.
trace	boolean	Trace to the surface; false places at z (Min.z) without filters. Default true.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.scatter_random (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
min	{x,y,z}	World-space minimum corner.
max	{x,y,z}	World-space maximum corner.
spacing	number	Grid spacing in centimetres. Default 100.
z	number	Placement height in centimetres. Default 0.
maxInstances	integer	Maximum instances to add. Default 1000.
seed	integer	Deterministic yaw seed. Default 0.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.select_instances (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
indices	array of integer	Instance indices.
replace	boolean	Replace selection when true; otherwise add. Default true.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.set_actor_type_settings (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Actor foliage type asset (FoliageType_Actor).
attachToBase	boolean	Attach spawned actors to the component they were placed on. Default true.
staticMeshOnly	boolean	5.0+: render the actor's static meshes as instances instead of spawning actors (ignored with a note on 4.27). Default false.

Returns: type, settings.

foliage.set_affect_distance_field (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_affect_dynamic_indirect_lighting (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_align_max_angle (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Value in degrees. Default 0.

Returns: type, settings.

foliage.set_align_to_normal (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_average_normal (risk 2, mutates, UE 5.0+, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Average the surface normal over several traces. Default true.
singleComponent	boolean	Only sample the component that was hit first. Default true.
sampleCount	integer	Number of normal samples (1..64). Default 10.

Returns: type, settings.

foliage.set_average_spread_distance (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_cast_shadow (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_collision_enabled (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_collision_profile (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
profile	string	required. Engine collision profile name.

Returns: type.

foliage.set_collision_radius (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_collision_scale (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
scale	{x,y,z}	Scale applied to the mesh bounds in the world-collision test. Default FUeaVec3(0.9,0.9,0.9).

Returns: type, settings.

foliage.set_component_class (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Instanced-static-mesh foliage type asset.
componentClass	string	required. Class deriving from FoliageInstancedStaticMeshComponent.

Returns: type, settings.

foliage.set_contact_shadow (risk 2, mutates, UE 5.0+, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested state. Default true.

Returns: type, settings.

foliage.set_cull_distance (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
min	number	Inclusive lower value. Default 0.
max	number	Inclusive upper value. Default 0.

Returns: type.

foliage.set_cull_distance_scaling (risk 2, mutates, UE 5.2+, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested state. Default true.

Returns: type, settings.

foliage.set_custom_data (risk 2, mutates, UE 5.3+, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
indices	array of integer	required. Instance indices.
channel	integer	Custom-data channel. Default 0.
value	number	Value for the channel. Default 0.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.set_custom_data_channels (risk 2, mutates, UE 5.3+, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered instanced-static-mesh foliage type.
count	integer	Custom data floats per instance (0..32). Default 1.

Returns: index, channels, values, component.

foliage.set_custom_depth (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Render into the custom depth pass. Default true.
stencilValue	integer	Stencil value 0..255. Default 0.

Returns: type, settings.

foliage.set_density (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_dynamic_shadow (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_evaluate_world_position_offset (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_ground_slope_filter (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
min	number	Inclusive lower value. Default 0.
max	number	Inclusive upper value. Default 0.

Returns: type.

foliage.set_height_filter (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
min	number	Inclusive lower value. Default 0.
max	number	Inclusive upper value. Default 0.

Returns: type.

foliage.set_include_in_hlod (risk 2, mutates, UE 5.0+, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_initial_seed_density (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_instance_transform (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required.
indices	array of integer	required.
transform	UeaFoliageTransform	required.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.set_instance_transforms (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
indices	array of integer	required. Instance indices.
transforms	array of UeaFoliageTransform	required. One transform per index.

Returns: instances, count, total, boundsMin, boundsMax.

foliage.set_lighting_channels (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
channel0	boolean	Lighting channel 0. Default true.
channel1	boolean	Lighting channel 1. Default false.
channel2	boolean	Lighting channel 2. Default false.

Returns: type, settings.

foliage.set_lightmap_resolution (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
override	boolean	Override the mesh lightmap resolution. Default true.
resolution	integer	Lightmap resolution (4..4096) used when overriding. Default 64.

Returns: type, settings.

foliage.set_material_override (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
slot	integer	Zero-based mesh material slot. Default 0.
material	string	required. Material-interface asset path.

Returns: type.

foliage.set_max_age (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_max_initial_age (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_max_initial_seed_offset (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_mesh (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
mesh	string	required. Static mesh asset path.

Returns: type.

foliage.set_minimum_layer_weight (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_mobility (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
mobility	string	required. Static, Stationary or Movable.

Returns: type, settings.

foliage.set_nanite_material_override (risk 2, mutates, UE 5.1+, smoke)

No description.

Argument	Type	Description
type	string	required. Instanced-static-mesh foliage type asset.
slot	integer	Zero-based slot. Default 0.
material	string	required. Material interface asset path.

Returns: type, settings.

foliage.set_num_steps (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_overlap_priority (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_procedural_distribution (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
spreadVariance	number	Variance of the spread distance (centimetres). Default 150.
distributionSeed	integer	Seed of the distribution. Default 0.
proceduralScaleMin	number	Scale of the youngest instance. Default 1.
proceduralScaleMax	number	Scale of the oldest instance. Default 3.

Returns: type, settings.

foliage.set_radius (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_random_pitch (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Value in degrees. Default 0.

Returns: type, settings.

foliage.set_random_yaw (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_receive_decals (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_runtime_virtual_texture (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_scalability (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
densityScaling	boolean	Scale instance density with foliage.DensityScale / scalability. Default false.
discardOnLoad	boolean	Discard instances on load when density scaling culls them. Default false.

Returns: type, settings.

foliage.set_seeds_per_step (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_shade_growth (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
canGrowInShade	boolean	Instances may grow in the shade of others. Default false.
spawnsInShade	boolean	New seeds may only spawn in shade. Default false.

Returns: type, settings.

foliage.set_shade_radius (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	number	Numeric value. Default 0.

Returns: type.

foliage.set_shadow_cache_invalidation (risk 2, mutates, UE 5.3+, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	string	required. Enum entry name (e.g. Auto, Always, Rigid, Static).

Returns: type, settings.

foliage.set_shadow_two_sided (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested state. Default true.

Returns: type, settings.

foliage.set_spawner (risk 2, mutates, smoke)

No description.

Argument	Type	Description
spawner	string	required.
property	string	required.
value	string	required.

Returns: spawner.

foliage.set_spawner_seed (risk 2, mutates, smoke)

No description.

Argument	Type	Description
spawner	string	required. Procedural foliage spawner asset.
value	integer	Integer seed/count or centimetre tile size. Default 0.
asset	UeaAssetInfo
randomSeed	integer	Default 0.
tileSize	number	Default 0.
numUniqueTiles	integer	Default 0.
typeCount	integer	Default 0.
types	array of string	Foliage type assets simulated by the spawner.

Returns: spawner.

foliage.set_spawner_tile_size (risk 2, mutates, smoke)

No description.

Argument	Type	Description
spawner	string	required. Procedural foliage spawner asset.
value	integer	Integer seed/count or centimetre tile size. Default 0.
asset	UeaAssetInfo
randomSeed	integer	Default 0.
tileSize	number	Default 0.
numUniqueTiles	integer	Default 0.
typeCount	integer	Default 0.
types	array of string	Foliage type assets simulated by the spawner.

Returns: spawner.

foliage.set_spawner_unique_tiles (risk 2, mutates, smoke)

No description.

Argument	Type	Description
spawner	string	required. Procedural foliage spawner asset.
value	integer	Integer seed/count or centimetre tile size. Default 0.
asset	UeaAssetInfo
randomSeed	integer	Default 0.
tileSize	number	Default 0.
numUniqueTiles	integer	Default 0.
typeCount	integer	Default 0.
types	array of string	Foliage type assets simulated by the spawner.

Returns: spawner.

foliage.set_static_shadow (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_translucency_sort_priority (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	integer	Integer value. Default 0.

Returns: type, settings.

foliage.set_type (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
property	string	required.
value	string	required.

Returns: type.

foliage.set_type_filters (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
landscapeLayers	array of string
exclusionLandscapeLayers	array of string
minimumLayerWeight	string
collisionWithWorld	string

Returns: type.

foliage.set_type_instance_settings (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
property	string	required.
value	string	required.

Returns: type.

foliage.set_type_placement (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
density	string
radius	string
zOffsetMin	string
zOffsetMax	string
alignToNormal	string
randomYaw	string
randomPitchAngle	string
groundSlopeMin	string
groundSlopeMax	string

Returns: type.

foliage.set_type_procedural (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
property	string	required.
value	string	required.

Returns: type.

foliage.set_type_scaling (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required.
scaling	string
scaleXMin	string
scaleXMax	string
scaleYMin	string
scaleYMax	string
scaleZMin	string
scaleZMax	string

Returns: type.

foliage.set_use_as_occluder (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested setting state. Default true.

Returns: type.

foliage.set_virtual_texture (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
textures	array of string	Runtime virtual texture asset paths written to (replaces the list; empty clears it).
cullMips	integer	Mips culled from the virtual texture pass (0..7). Default 0.
passType	string	Main-pass rendering: Never, Exclusive or Always. Default TEXT("Exclusive").

Returns: type, settings.

foliage.set_visible_in_ray_tracing (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
enabled	boolean	Requested state. Default true.

Returns: type, settings.

foliage.set_volume (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
volume	string	required. Exact label of a ProceduralFoliageVolume.
spawner	string	New spawner asset; empty keeps the current one.
setLocation	boolean	Move the volume to location. Default false.
location	{x,y,z}	New centre (with setLocation).
extent	{x,y,z}	New box half size; all zero keeps the brush.
tileOverlap	number	New tile overlap (cm); negative keeps the current value. Default -1.

Returns: volume.

foliage.set_volume_filters (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
volume	string	required. Exact label of a ProceduralFoliageVolume.
allowLandscape	boolean	Spawn on landscapes. Default true.
allowBSP	boolean	Spawn on BSP. Default true.
allowStaticMesh	boolean	Spawn on static meshes. Default true.
allowTranslucent	boolean	Spawn on translucent geometry. Default false.
allowFoliage	boolean	Spawn on other foliage. Default false.

Returns: volume.

foliage.set_wpo_disable_distance (risk 2, mutates, UE 5.1+, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
value	integer	Integer value. Default 0.

Returns: type, settings.

foliage.set_z_offset (risk 2, mutates, smoke)

No description.

Argument	Type	Description
type	string	required. Foliage type asset.
min	number	Inclusive lower value. Default 0.
max	number	Inclusive upper value. Default 0.

Returns: type.

foliage.simulate (risk 2, mutates, requires world, dryRun, smoke)

No description.

Argument	Type	Description
volume	string	required. Exact label of a ProceduralFoliageVolume.
respectFilters	boolean	Apply the type slope, height and landscape-layer filters to the traced hits. Default true.
dryRun	boolean	Run the simulation and traces without replacing the volume's instances. Default false.

Returns: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.

foliage.snap_to_ground (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type.
indices	array of integer	Instance indices; empty means every instance.
alignToNormal	boolean	Align to the surface normal (keeps yaw). Default false.
traceHalfHeight	number	Trace half height (cm). Default 5000.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.stats (risk 0, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Default TEXT("/Game").

Returns: items, count, changed, warnings, dryRun.

foliage.thin_instances (risk 3, mutates, destructive, requires world, dryRun, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type.
minDistance	number	Minimum distance (cm); 0 uses the type radius. Default 0.
dryRun	boolean	Report without removing. Default false.

Returns: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.

foliage.to_static_mesh_actors (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered instanced-static-mesh foliage type.
indices	array of integer	Instance indices; empty converts every instance (max 1000).
labelPrefix	string	Label prefix; actors are labelled _. Default TEXT("FoliageActor").
removeInstances	boolean	Remove the converted instances. Default false.

Returns: actors, count, removed, total.

foliage.transform_region (risk 2, mutates, requires world, smoke)

No description.

Argument	Type	Description
type	string	required. Registered foliage type asset.
min	{x,y,z}	Box minimum.
max	{x,y,z}	Box maximum.
offset	{x,y,z}	World offset added to each instance.
rotationDelta	{x,y,z}	Rotation delta (pitch, yaw, roll) applied to each instance.
scaleMultiplier	{x,y,z}	Per-axis scale multiplier. Default FUeaVec3(1,1,1).

Returns: instances, count, total, boundsMin, boundsMax.

foliage.validate (risk 0, smoke)

No description.

Argument	Type	Description
folder	string	Default TEXT("/Game").

Returns: items, count, changed, warnings, dryRun.

foliage.validate_spawner (risk 0, smoke)

No description.

Argument	Type	Description
spawner	string	required.

Returns: spawner.

foliage.volume_stats (risk 0, requires world, smoke)

No description.

Argument	Type	Description
volume	string	required. Exact label of a ProceduralFoliageVolume.

Returns: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.