Kit foliage
184 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.
As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em
tools/list).
Guia
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_normal5.0+), filters (set_ground_slope_filter,set_height_filter,set_type_filtersfor landscape layers), scaling (set_type_scaling), culling and scalability (set_cull_distance,set_scalability,set_cull_distance_scaling5.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_shadow5.0+,set_shadow_cache_invalidation5.3+,set_visible_in_ray_tracing,set_wpo_disable_distance5.1+,set_virtual_texture), collision (set_collision_enabled,set_collision_profile,set_collision_scale), mesh (set_mesh,set_material_override,set_nanite_material_override5.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_typeremains 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 withlist_level_types,count,get_bounds. - Explicit placement:
add_instances/add_instancewith transforms;scatter_gridandscatter_randomplace 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_allclears 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_instanceswritesSaved/UEAMCP/Foliage/<file>.json(layoutx,y,z,pitch,yaw,roll,scaleX,scaleY,scaleZper type);import_instancesvalidates the whole file first, then inserts (replace:trueclears each target type first,typeredirects 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).
countfixes the sample count;count:0derives it from the type density (instances per 1000x1000 cm).- The reply reports
attempts,placed,noHit,slope,height,layer,collision,overlap;dryRun:truereports without inserting. Usepreview_traceto see what one sample would hit and which filter rejects it. paint_actoronly accepts hits on the named actor (exact label).scatter_poissonuses Bridson sampling withminDistance;trace:falseinserts atmin.zwithout 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,dryRunavailable). create_groundspawns (or reuses by label) a 10 cm collision slab from/Engine/BasicShapes/Cubewhen a blockout needs a surface.
Recipe: forest floor on a landscape layer
foliage.create_type→set_type_filters {landscapeLayers:['Grass'], minimumLayerWeight:'0.5'}→set_ground_slope_filter {min:0,max:30}.foliage.paint_box {min,max, count:0, seed:1, dryRun:true}and read the rejection counters.- Run it again without
dryRun;foliage.thin_instancesif 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). simulaterunsUProceduralFoliageComponent::GenerateProceduralContent, removes the volume's previous instances, traces every desired instance with the volume's surface flags, applies the type filters and inserts throughFPotentialInstance::PlaceInstance+FFoliageInfo, stamping the volume's procedural GUID.resimulate_alldoes it for every volume;volume_statscounts the stamped instances per type;clear_volumeremoves 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 withwarning,valueand world instance counts.batch_set_*(cull distance, shadows, collision profile, density, radius, mobility, scale, ...) andreplace_type_meshacceptdryRun:trueand reportbefore -> afterper 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_settingsrejectsstaticMeshOnly:trueon 4.27. - Not available: the interactive paint/erase/lasso brushes of the Foliage editor mode
(
FoliageEditis private). The tools above cover the same outcomes headlessly.
Ferramentas
Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de
MaxAutoRiskexigem"_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumentodryRun. smoke = coberto poredit.self_test.
foliage.add_blocking_volume (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
label | string | obrigatório. 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). Padrão FUeaVec3(200,200,500). |
Retorna: volume.
foliage.add_instance (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
transforms | array of UeaFoliageTransform | obrigatório. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.add_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
transforms | array of UeaFoliageTransform | obrigatório. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.add_spawner_type (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. Procedural foliage spawner asset. |
type | string | obrigatório. Foliage type asset. |
Retorna: spawner.
foliage.add_type_to_level (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: types, count.
foliage.add_volume (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
label | string | obrigatório. Actor label (must be unused). |
spawner | string | obrigatório. Procedural foliage spawner asset. |
location | {x,y,z} | Volume centre. |
extent | {x,y,z} | Box half size (cm). Padrão FUeaVec3(1000,1000,500). |
tileOverlap | number | Overlap between simulation tiles (cm). Padrão 0. |
Retorna: volume.
foliage.audit (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Padrão TEXT("/Game"). |
Retorna: items, count, changed, warnings, dryRun.
foliage.audit_collision (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
minInstances | integer | Only flag types with at least this many instances in the editor world. Padrão 0. |
Retorna: items, count, changed, warnings, dryRun.
foliage.audit_cull_distance (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
maxEndDistance | integer | Flag end distances above this value (0 flags only never-culled types). Padrão 0. |
Retorna: items, count, changed, warnings, dryRun.
foliage.audit_density (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
maxDensity | number | Density (instances per 1000x1000 cm) above which a type is flagged. Padrão 100. |
Retorna: items, count, changed, warnings, dryRun.
foliage.audit_shadows (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
minInstances | integer | Only flag types with at least this many instances in the editor world. Padrão 0. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_align_to_normal (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_collision (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
profile | string | obrigatório. Collision profile name. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_contact_shadow (risco 2, altera, UE 5.0+, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_cull_distance (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
startDistance | integer | Cull start distance (cm). Padrão 0. |
endDistance | integer | Cull end distance (cm). Padrão 10000. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_decals (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_density (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | number | Value applied to every matching foliage type. Padrão 0. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_density_scaling (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_distance_field (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_dynamic_shadow (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_hlod (risco 2, altera, UE 5.0+, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_indirect_lighting (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_mobility (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
mobility | string | obrigatório. Static, Stationary or Movable. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_occluder (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_radius (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | number | Value applied to every matching foliage type. Padrão 0. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_random_yaw (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_scale (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
min | number | Minimum uniform scale. Padrão 1. |
max | number | Maximum uniform scale. Padrão 1. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_shadows (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_static_shadow (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.batch_set_wpo (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
value | boolean | Value applied to every type. Padrão true. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.cleanup_invalid (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
allLevels | boolean | Every loaded level instead of only the current level. Padrão false. |
dryRun | boolean | Report without applying (clean-up tools). Padrão false. |
Retorna: types, actors, removed, deletedTypes, dryRun.
foliage.clear_selection (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
offset | integer | Padrão 0. |
limit | integer | Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.clear_volume (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
volume | string | obrigatório. Exact label of a ProceduralFoliageVolume. |
Retorna: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.
foliage.count (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
offset | integer | Padrão 0. |
limit | integer | Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.create_actor_type (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
actorClass | string | obrigatório. |
Retorna: type.
foliage.create_ground (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
label | string | Actor label; an existing static-mesh actor with this label is reused and resized. Padrão 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. Padrão FUeaVec3(1000,1000,0). |
Retorna: label, path, reused, boundsMin, boundsMax.
foliage.create_spawner (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
randomSeed | integer | Padrão 0. |
tileSize | number | Padrão 10000. |
numUniqueTiles | integer | Padrão 1. |
Retorna: spawner.
foliage.create_type (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
mesh | string | obrigatório. |
Retorna: type.
foliage.delete_type (risco 3, altera, destrutivo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
foliage.duplicate_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
indices | array of integer | obrigatório. Source instance indices. |
offset | {x,y,z} | World offset of the copies. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.duplicate_type (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
folder | string | obrigatório. |
name | string | obrigatório. |
Retorna: type.
foliage.export_instances (risco 1, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | Registered foliage type; empty exports every type of the current level. |
file | string | obrigatório. Bare file name (letters, digits, _ and -), without extension. |
Retorna: path, instances, types.
foliage.find_instances (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
inBox | boolean | Restrict to the min/max box. Padrão 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. Padrão 0. |
minZ | number | Minimum instance Z. Padrão -1.0e9. |
maxZ | number | Maximum instance Z. Padrão 1.0e9. |
minScale | number | Minimum of the largest scale axis. Padrão 0. |
maxScale | number | Maximum of the largest scale axis. Padrão 1.0e9. |
limit | integer | Maximum returned records. Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.find_types_by_mesh (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
mesh | string | obrigatório. |
folder | string | Padrão TEXT("/Game"). |
Retorna: items, count, changed, warnings, dryRun.
foliage.find_unused_types (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Padrão TEXT("/Game"). |
Retorna: items, count, changed, warnings, dryRun.
foliage.from_static_mesh_actors (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
actors | array of string | obrigatório. Exact labels of StaticMeshActors whose mesh equals the type mesh. |
type | string | obrigatório. Instanced-static-mesh foliage type receiving the instances. |
deleteActors | boolean | Delete the actors after conversion. Padrão false. |
Retorna: actors, count, removed, total.
foliage.get_bounds (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
offset | integer | Padrão 0. |
limit | integer | Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.get_collision (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type, settings.
foliage.get_culling (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type, settings.
foliage.get_custom_data (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
index | integer | Padrão -1. |
Retorna: index, channels, values, component.
foliage.get_instance (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
index | integer | Padrão -1. |
Retorna: instance, count.
foliage.get_instances (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
offset | integer | Padrão 0. |
limit | integer | Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.get_instances_in_box (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. 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. Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.get_instances_in_sphere (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
center | {x,y,z} | World-space centre. |
radius | number | Sphere radius in centimetres. Padrão 100. |
limit | integer | Maximum returned records. Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.get_lighting (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type, settings.
foliage.get_placement (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type, settings.
foliage.get_procedural_settings (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type, settings.
foliage.get_rendering (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type, settings.
foliage.get_scaling (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type, settings.
foliage.get_selected_instances (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
offset | integer | Padrão 0. |
limit | integer | Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.get_spawner (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. |
Retorna: spawner.
foliage.get_type (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type.
foliage.get_volume (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
volume | string | obrigatório. Exact label of a ProceduralFoliageVolume. |
Retorna: volume.
foliage.import_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. 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. Padrão false. |
Retorna: path, instances, types.
foliage.list_foliage_actors (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
allLevels | boolean | Every loaded level instead of only the current level. Padrão false. |
dryRun | boolean | Report without applying (clean-up tools). Padrão false. |
Retorna: actors, count, instances.
foliage.list_level_types (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Padrão TEXT("/Game"). |
limit | integer | Padrão 100. |
Retorna: types, count.
foliage.list_spawner_types (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. |
Retorna: spawner.
foliage.list_spawners (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan recursively. Padrão TEXT("/Game"). |
Retorna: spawners, count.
foliage.list_types (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Padrão TEXT("/Game"). |
limit | integer | Padrão 100. |
Retorna: types, count.
foliage.list_volumes (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
includeBlocking | boolean | Include procedural blocking volumes. Padrão true. |
Retorna: volumes, count, removedInstances.
foliage.move_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
indices | array of integer | obrigatório. |
offset | {x,y,z} |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.move_instances_to_type (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered source foliage type. |
indices | array of integer | obrigatório. Instance indices. |
targetType | string | obrigatório. Destination foliage type asset. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.move_to_level (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | Registered foliage type; empty moves every type. |
indices | array of integer | Instance indices (with type); empty moves every instance. |
level | string | obrigatório. Target level: "persistent", the package short name or the full package name of a loaded level. |
Retorna: sourceLevel, targetLevel, moved, note.
foliage.nearest_instance (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
location | {x,y,z} | obrigatório. |
Retorna: instance, count.
foliage.paint_actor (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
actor | string | obrigatório. Actor label or name whose surfaces receive instances. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.paint_box (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
min | {x,y,z} | Box minimum (x, y; z averaged with max as the trace mid-height). |
max | {x,y,z} | Box maximum. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.paint_circle (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
center | {x,y,z} | Circle centre; z is the trace mid-height. |
radius | number | Circle radius (cm). Padrão 500. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.paint_line (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
start | {x,y,z} | Segment start. |
end | {x,y,z} | Segment end. |
spacing | number | Distance between samples (cm). Padrão 100. |
jitter | number | Random XY offset of each sample (cm). Padrão 0. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.preview_trace (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type whose filters are evaluated. |
location | {x,y,z} | Sample position; z is the trace mid-height. |
traceHalfHeight | number | Trace half height (cm). Padrão 5000. |
Retorna: hit, location, normal, slopeDegrees, actor, component, landscape, rejection.
foliage.randomize_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
indices | array of integer | Instance indices; empty means every instance. |
seed | integer | Random seed. Padrão 0. |
randomYaw | boolean | Replace yaw with a random value. Padrão true. |
scaleMin | number | Minimum uniform scale. Padrão 1. |
scaleMax | number | Maximum uniform scale. Padrão 1. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.reapply_settings (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type. |
indices | array of integer | Instance indices; empty means every instance. |
seed | integer | Random seed. Padrão 0. |
scale | boolean | Re-roll scale from the scaling mode and ranges. Padrão true. |
yaw | boolean | Re-roll yaw (0..360). Padrão true. |
pitch | boolean | Re-roll pitch within RandomPitchAngle. Padrão false. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.rebuild (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
offset | integer | Padrão 0. |
limit | integer | Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.rebuild_all (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
allLevels | boolean | Every loaded level instead of only the current level. Padrão false. |
dryRun | boolean | Report without applying (clean-up tools). Padrão false. |
Retorna: types, actors, removed, deletedTypes, dryRun.
foliage.remove_all (risco 3, altera, destrutivo, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
allLevels | boolean | Every loaded level instead of only the current level. Padrão false. |
dryRun | boolean | Report without applying (clean-up tools). Padrão false. |
Retorna: types, actors, removed, deletedTypes, dryRun.
foliage.remove_by_type (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
offset | integer | Padrão 0. |
limit | integer | Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.remove_filtered (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
inBox | boolean | Restrict to the min/max box. Padrão 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. Padrão 0. |
minZ | number | Minimum instance Z. Padrão -1.0e9. |
maxZ | number | Maximum instance Z. Padrão 1.0e9. |
minScale | number | Minimum of the largest scale axis. Padrão 0. |
maxScale | number | Maximum of the largest scale axis. Padrão 1.0e9. |
limit | integer | Maximum returned records. Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.remove_in_box (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. 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. Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.remove_in_sphere (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
center | {x,y,z} | World-space centre. |
radius | number | Sphere radius in centimetres. Padrão 100. |
limit | integer | Maximum returned records. Padrão 100. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.remove_indices (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
indices | array of integer | obrigatório. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.remove_spawner_type (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. Procedural foliage spawner asset. |
type | string | obrigatório. Foliage type asset. |
Retorna: spawner.
foliage.remove_type_from_level (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: types, count.
foliage.remove_unused_level_types (risco 3, altera, destrutivo, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
dryRun | boolean | Report without applying. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.remove_volume (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
volumes | array of string | obrigatório. Exact labels of ProceduralFoliageVolume or ProceduralFoliageBlockingVolume actors. |
clearInstances | boolean | Remove the instances spawned by each procedural volume first. Padrão true. |
Retorna: volumes, count, removedInstances.
foliage.rename_type (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
name | string | obrigatório. |
Retorna: type.
foliage.replace_type (risco 3, altera, destrutivo, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
sourceType | string | obrigatório. Existing registered foliage type. |
targetType | string | obrigatório. Destination foliage type asset. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.replace_type_mesh (risco 2, altera, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to scan. Padrão TEXT("/Game"). |
fromMesh | string | obrigatório. Static mesh currently used by the types. |
toMesh | string | obrigatório. Static mesh assigned instead. |
dryRun | boolean | Report the per-type changes without applying them. Padrão false. |
Retorna: items, count, changed, warnings, dryRun.
foliage.resimulate_all (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
respectFilters | boolean | Apply the type slope, height and landscape-layer filters to the traced hits. Padrão true. |
dryRun | boolean | Run the simulations and traces without replacing instances. Padrão false. |
Retorna: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.
foliage.rotate_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
indices | array of integer | obrigatório. |
delta | {x,y,z} |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.save_type (risco 2)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
Retorna: type.
foliage.scale_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
indices | array of integer | obrigatório. |
multiplier | {x,y,z} | Padrão FUeaVec3(1,1,1). |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.scatter_grid (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. 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. Padrão 100. |
z | number | Placement height in centimetres. Padrão 0. |
maxInstances | integer | Maximum instances to add. Padrão 1000. |
seed | integer | Deterministic yaw seed. Padrão 0. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.scatter_poisson (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
min | {x,y,z} | Rectangle minimum. |
max | {x,y,z} | Rectangle maximum. |
minDistance | number | Minimum distance between samples (cm). Padrão 100. |
trace | boolean | Trace to the surface; false places at z (Min.z) without filters. Padrão true. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.scatter_random (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. 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. Padrão 100. |
z | number | Placement height in centimetres. Padrão 0. |
maxInstances | integer | Maximum instances to add. Padrão 1000. |
seed | integer | Deterministic yaw seed. Padrão 0. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.select_instances (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
indices | array of integer | Instance indices. |
replace | boolean | Replace selection when true; otherwise add. Padrão true. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.set_actor_type_settings (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Actor foliage type asset (FoliageType_Actor). |
attachToBase | boolean | Attach spawned actors to the component they were placed on. Padrão true. |
staticMeshOnly | boolean | 5.0+: render the actor's static meshes as instances instead of spawning actors (ignored with a note on 4.27). Padrão false. |
Retorna: type, settings.
foliage.set_affect_distance_field (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_affect_dynamic_indirect_lighting (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_align_max_angle (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Value in degrees. Padrão 0. |
Retorna: type, settings.
foliage.set_align_to_normal (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_average_normal (risco 2, altera, UE 5.0+, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Average the surface normal over several traces. Padrão true. |
singleComponent | boolean | Only sample the component that was hit first. Padrão true. |
sampleCount | integer | Number of normal samples (1..64). Padrão 10. |
Retorna: type, settings.
foliage.set_average_spread_distance (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_cast_shadow (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_collision_enabled (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_collision_profile (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
profile | string | obrigatório. Engine collision profile name. |
Retorna: type.
foliage.set_collision_radius (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_collision_scale (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
scale | {x,y,z} | Scale applied to the mesh bounds in the world-collision test. Padrão FUeaVec3(0.9,0.9,0.9). |
Retorna: type, settings.
foliage.set_component_class (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Instanced-static-mesh foliage type asset. |
componentClass | string | obrigatório. Class deriving from FoliageInstancedStaticMeshComponent. |
Retorna: type, settings.
foliage.set_contact_shadow (risco 2, altera, UE 5.0+, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested state. Padrão true. |
Retorna: type, settings.
foliage.set_cull_distance (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
min | number | Inclusive lower value. Padrão 0. |
max | number | Inclusive upper value. Padrão 0. |
Retorna: type.
foliage.set_cull_distance_scaling (risco 2, altera, UE 5.2+, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested state. Padrão true. |
Retorna: type, settings.
foliage.set_custom_data (risco 2, altera, UE 5.3+, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
indices | array of integer | obrigatório. Instance indices. |
channel | integer | Custom-data channel. Padrão 0. |
value | number | Value for the channel. Padrão 0. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.set_custom_data_channels (risco 2, altera, UE 5.3+, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered instanced-static-mesh foliage type. |
count | integer | Custom data floats per instance (0..32). Padrão 1. |
Retorna: index, channels, values, component.
foliage.set_custom_depth (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Render into the custom depth pass. Padrão true. |
stencilValue | integer | Stencil value 0..255. Padrão 0. |
Retorna: type, settings.
foliage.set_density (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_dynamic_shadow (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_evaluate_world_position_offset (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_ground_slope_filter (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
min | number | Inclusive lower value. Padrão 0. |
max | number | Inclusive upper value. Padrão 0. |
Retorna: type.
foliage.set_height_filter (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
min | number | Inclusive lower value. Padrão 0. |
max | number | Inclusive upper value. Padrão 0. |
Retorna: type.
foliage.set_include_in_hlod (risco 2, altera, UE 5.0+, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_initial_seed_density (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_instance_transform (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
indices | array of integer | obrigatório. |
transform | UeaFoliageTransform | obrigatório. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.set_instance_transforms (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type asset. |
indices | array of integer | obrigatório. Instance indices. |
transforms | array of UeaFoliageTransform | obrigatório. One transform per index. |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.set_lighting_channels (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
channel0 | boolean | Lighting channel 0. Padrão true. |
channel1 | boolean | Lighting channel 1. Padrão false. |
channel2 | boolean | Lighting channel 2. Padrão false. |
Retorna: type, settings.
foliage.set_lightmap_resolution (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
override | boolean | Override the mesh lightmap resolution. Padrão true. |
resolution | integer | Lightmap resolution (4..4096) used when overriding. Padrão 64. |
Retorna: type, settings.
foliage.set_material_override (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
slot | integer | Zero-based mesh material slot. Padrão 0. |
material | string | obrigatório. Material-interface asset path. |
Retorna: type.
foliage.set_max_age (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_max_initial_age (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_max_initial_seed_offset (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_mesh (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
mesh | string | obrigatório. Static mesh asset path. |
Retorna: type.
foliage.set_minimum_layer_weight (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_mobility (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
mobility | string | obrigatório. Static, Stationary or Movable. |
Retorna: type, settings.
foliage.set_nanite_material_override (risco 2, altera, UE 5.1+, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Instanced-static-mesh foliage type asset. |
slot | integer | Zero-based slot. Padrão 0. |
material | string | obrigatório. Material interface asset path. |
Retorna: type, settings.
foliage.set_num_steps (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_overlap_priority (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_procedural_distribution (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
spreadVariance | number | Variance of the spread distance (centimetres). Padrão 150. |
distributionSeed | integer | Seed of the distribution. Padrão 0. |
proceduralScaleMin | number | Scale of the youngest instance. Padrão 1. |
proceduralScaleMax | number | Scale of the oldest instance. Padrão 3. |
Retorna: type, settings.
foliage.set_radius (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_random_pitch (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Value in degrees. Padrão 0. |
Retorna: type, settings.
foliage.set_random_yaw (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_receive_decals (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_runtime_virtual_texture (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_scalability (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
densityScaling | boolean | Scale instance density with foliage.DensityScale / scalability. Padrão false. |
discardOnLoad | boolean | Discard instances on load when density scaling culls them. Padrão false. |
Retorna: type, settings.
foliage.set_seeds_per_step (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_shade_growth (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
canGrowInShade | boolean | Instances may grow in the shade of others. Padrão false. |
spawnsInShade | boolean | New seeds may only spawn in shade. Padrão false. |
Retorna: type, settings.
foliage.set_shade_radius (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | number | Numeric value. Padrão 0. |
Retorna: type.
foliage.set_shadow_cache_invalidation (risco 2, altera, UE 5.3+, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | string | obrigatório. Enum entry name (e.g. Auto, Always, Rigid, Static). |
Retorna: type, settings.
foliage.set_shadow_two_sided (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested state. Padrão true. |
Retorna: type, settings.
foliage.set_spawner (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. |
property | string | obrigatório. |
value | string | obrigatório. |
Retorna: spawner.
foliage.set_spawner_seed (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. Procedural foliage spawner asset. |
value | integer | Integer seed/count or centimetre tile size. Padrão 0. |
asset | UeaAssetInfo | |
randomSeed | integer | Padrão 0. |
tileSize | number | Padrão 0. |
numUniqueTiles | integer | Padrão 0. |
typeCount | integer | Padrão 0. |
types | array of string | Foliage type assets simulated by the spawner. |
Retorna: spawner.
foliage.set_spawner_tile_size (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. Procedural foliage spawner asset. |
value | integer | Integer seed/count or centimetre tile size. Padrão 0. |
asset | UeaAssetInfo | |
randomSeed | integer | Padrão 0. |
tileSize | number | Padrão 0. |
numUniqueTiles | integer | Padrão 0. |
typeCount | integer | Padrão 0. |
types | array of string | Foliage type assets simulated by the spawner. |
Retorna: spawner.
foliage.set_spawner_unique_tiles (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. Procedural foliage spawner asset. |
value | integer | Integer seed/count or centimetre tile size. Padrão 0. |
asset | UeaAssetInfo | |
randomSeed | integer | Padrão 0. |
tileSize | number | Padrão 0. |
numUniqueTiles | integer | Padrão 0. |
typeCount | integer | Padrão 0. |
types | array of string | Foliage type assets simulated by the spawner. |
Retorna: spawner.
foliage.set_static_shadow (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_translucency_sort_priority (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | integer | Integer value. Padrão 0. |
Retorna: type, settings.
foliage.set_type (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
property | string | obrigatório. |
value | string | obrigatório. |
Retorna: type.
foliage.set_type_filters (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
landscapeLayers | array of string | |
exclusionLandscapeLayers | array of string | |
minimumLayerWeight | string | |
collisionWithWorld | string |
Retorna: type.
foliage.set_type_instance_settings (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
property | string | obrigatório. |
value | string | obrigatório. |
Retorna: type.
foliage.set_type_placement (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
density | string | |
radius | string | |
zOffsetMin | string | |
zOffsetMax | string | |
alignToNormal | string | |
randomYaw | string | |
randomPitchAngle | string | |
groundSlopeMin | string | |
groundSlopeMax | string |
Retorna: type.
foliage.set_type_procedural (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
property | string | obrigatório. |
value | string | obrigatório. |
Retorna: type.
foliage.set_type_scaling (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. |
scaling | string | |
scaleXMin | string | |
scaleXMax | string | |
scaleYMin | string | |
scaleYMax | string | |
scaleZMin | string | |
scaleZMax | string |
Retorna: type.
foliage.set_use_as_occluder (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested setting state. Padrão true. |
Retorna: type.
foliage.set_virtual_texture (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. 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). Padrão 0. |
passType | string | Main-pass rendering: Never, Exclusive or Always. Padrão TEXT("Exclusive"). |
Retorna: type, settings.
foliage.set_visible_in_ray_tracing (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
enabled | boolean | Requested state. Padrão true. |
Retorna: type, settings.
foliage.set_volume (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
volume | string | obrigatório. Exact label of a ProceduralFoliageVolume. |
spawner | string | New spawner asset; empty keeps the current one. |
setLocation | boolean | Move the volume to location. Padrão 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. Padrão -1. |
Retorna: volume.
foliage.set_volume_filters (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
volume | string | obrigatório. Exact label of a ProceduralFoliageVolume. |
allowLandscape | boolean | Spawn on landscapes. Padrão true. |
allowBSP | boolean | Spawn on BSP. Padrão true. |
allowStaticMesh | boolean | Spawn on static meshes. Padrão true. |
allowTranslucent | boolean | Spawn on translucent geometry. Padrão false. |
allowFoliage | boolean | Spawn on other foliage. Padrão false. |
Retorna: volume.
foliage.set_wpo_disable_distance (risco 2, altera, UE 5.1+, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
value | integer | Integer value. Padrão 0. |
Retorna: type, settings.
foliage.set_z_offset (risco 2, altera, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Foliage type asset. |
min | number | Inclusive lower value. Padrão 0. |
max | number | Inclusive upper value. Padrão 0. |
Retorna: type.
foliage.simulate (risco 2, altera, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
volume | string | obrigatório. Exact label of a ProceduralFoliageVolume. |
respectFilters | boolean | Apply the type slope, height and landscape-layer filters to the traced hits. Padrão true. |
dryRun | boolean | Run the simulation and traces without replacing the volume's instances. Padrão false. |
Retorna: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.
foliage.snap_to_ground (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type. |
indices | array of integer | Instance indices; empty means every instance. |
alignToNormal | boolean | Align to the surface normal (keeps yaw). Padrão false. |
traceHalfHeight | number | Trace half height (cm). Padrão 5000. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.stats (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Padrão TEXT("/Game"). |
Retorna: items, count, changed, warnings, dryRun.
foliage.thin_instances (risco 3, altera, destrutivo, requer mundo, dryRun, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Registered foliage type. |
minDistance | number | Minimum distance (cm); 0 uses the type radius. Padrão 0. |
dryRun | boolean | Report without removing. Padrão false. |
Retorna: type, attempts, placed, noHit, slope, height, layer, collision, overlap, removed, total, dryRun, instances.
foliage.to_static_mesh_actors (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. 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 TEXT("FoliageActor"). |
removeInstances | boolean | Remove the converted instances. Padrão false. |
Retorna: actors, count, removed, total.
foliage.transform_region (risco 2, altera, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. 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. Padrão FUeaVec3(1,1,1). |
Retorna: instances, count, total, boundsMin, boundsMax.
foliage.validate (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Padrão TEXT("/Game"). |
Retorna: items, count, changed, warnings, dryRun.
foliage.validate_spawner (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
spawner | string | obrigatório. |
Retorna: spawner.
foliage.volume_stats (risco 0, requer mundo, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
volume | string | obrigatório. Exact label of a ProceduralFoliageVolume. |
Retorna: volumes, desired, placed, noHit, slope, height, layer, collision, removed, instances, types, dryRun.