Pular para o conteúdo principal

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_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.

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 MaxAutoRisk exigem "_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 argumento dryRun. smoke = coberto por edit.self_test.

foliage.add_blocking_volume (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
labelstringobrigatório. Actor label (must be unused).
volumestringProcedural 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.

ArgumentoTipoDescrição
typestringobrigatório.
transformsarray of UeaFoliageTransformobrigatório.

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

foliage.add_instances (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
transformsarray of UeaFoliageTransformobrigatório.

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

foliage.add_spawner_type (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório. Procedural foliage spawner asset.
typestringobrigatório. Foliage type asset.

Retorna: spawner.

foliage.add_type_to_level (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: types, count.

foliage.add_volume (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
labelstringobrigatório. Actor label (must be unused).
spawnerstringobrigató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).
tileOverlapnumberOverlap between simulation tiles (cm). Padrão 0.

Retorna: volume.

foliage.audit (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringPadrão TEXT("/Game").

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

foliage.audit_collision (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
minInstancesintegerOnly 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
maxEndDistanceintegerFlag 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
maxDensitynumberDensity (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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
minInstancesintegerOnly 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
profilestringobrigatório. Collision profile name.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
startDistanceintegerCull start distance (cm). Padrão 0.
endDistanceintegerCull end distance (cm). Padrão 10000.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuenumberValue applied to every matching foliage type. Padrão 0.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
mobilitystringobrigatório. Static, Stationary or Movable.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuenumberValue applied to every matching foliage type. Padrão 0.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
minnumberMinimum uniform scale. Padrão 1.
maxnumberMaximum uniform scale. Padrão 1.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
valuebooleanValue applied to every type. Padrão true.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
allLevelsbooleanEvery loaded level instead of only the current level. Padrão false.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
typestringobrigatório.
offsetintegerPadrão 0.
limitintegerPadrão 100.

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

foliage.clear_volume (risco 3, altera, destrutivo, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
volumestringobrigató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.

ArgumentoTipoDescrição
typestringobrigatório.
offsetintegerPadrão 0.
limitintegerPadrão 100.

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

foliage.create_actor_type (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
actorClassstringobrigatório.

Retorna: type.

foliage.create_ground (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
labelstringActor 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.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
randomSeedintegerPadrão 0.
tileSizenumberPadrão 10000.
numUniqueTilesintegerPadrão 1.

Retorna: spawner.

foliage.create_type (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
meshstringobrigatório.

Retorna: type.

foliage.delete_type (risco 3, altera, destrutivo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

foliage.duplicate_instances (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
indicesarray of integerobrigató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.

ArgumentoTipoDescrição
typestringobrigatório.
folderstringobrigatório.
namestringobrigatório.

Retorna: type.

foliage.export_instances (risco 1, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringRegistered foliage type; empty exports every type of the current level.
filestringobrigatório. Bare file name (letters, digits, _ and -), without extension.

Retorna: path, instances, types.

foliage.find_instances (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
inBoxbooleanRestrict 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).
radiusnumberSphere radius in centimetres; 0 disables the sphere test. Padrão 0.
minZnumberMinimum instance Z. Padrão -1.0e9.
maxZnumberMaximum instance Z. Padrão 1.0e9.
minScalenumberMinimum of the largest scale axis. Padrão 0.
maxScalenumberMaximum of the largest scale axis. Padrão 1.0e9.
limitintegerMaximum returned records. Padrão 100.

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

foliage.find_types_by_mesh (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
meshstringobrigatório.
folderstringPadrão TEXT("/Game").

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

foliage.find_unused_types (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringPadrão TEXT("/Game").

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

foliage.from_static_mesh_actors (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorsarray of stringobrigatório. Exact labels of StaticMeshActors whose mesh equals the type mesh.
typestringobrigatório. Instanced-static-mesh foliage type receiving the instances.
deleteActorsbooleanDelete the actors after conversion. Padrão false.

Retorna: actors, count, removed, total.

foliage.get_bounds (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
offsetintegerPadrão 0.
limitintegerPadrão 100.

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

foliage.get_collision (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type, settings.

foliage.get_culling (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type, settings.

foliage.get_custom_data (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
indexintegerPadrão -1.

Retorna: index, channels, values, component.

foliage.get_instance (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
indexintegerPadrão -1.

Retorna: instance, count.

foliage.get_instances (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
offsetintegerPadrão 0.
limitintegerPadrão 100.

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

foliage.get_instances_in_box (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
min{x,y,z}World-space inclusive minimum bound.
max{x,y,z}World-space inclusive maximum bound.
limitintegerMaximum returned records. Padrão 100.

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

foliage.get_instances_in_sphere (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
center{x,y,z}World-space centre.
radiusnumberSphere radius in centimetres. Padrão 100.
limitintegerMaximum returned records. Padrão 100.

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

foliage.get_lighting (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type, settings.

foliage.get_placement (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type, settings.

foliage.get_procedural_settings (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type, settings.

foliage.get_rendering (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type, settings.

foliage.get_scaling (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type, settings.

foliage.get_selected_instances (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
offsetintegerPadrão 0.
limitintegerPadrão 100.

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

foliage.get_spawner (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório.

Retorna: spawner.

foliage.get_type (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type.

foliage.get_volume (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
volumestringobrigatório. Exact label of a ProceduralFoliageVolume.

Retorna: volume.

foliage.import_instances (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
filestringobrigatório. Bare file name written by foliage.export_instances.
typestringImport every record into this type instead of the recorded ones.
replacebooleanRemove 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.

ArgumentoTipoDescrição
allLevelsbooleanEvery loaded level instead of only the current level. Padrão false.
dryRunbooleanReport without applying (clean-up tools). Padrão false.

Retorna: actors, count, instances.

foliage.list_level_types (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringPadrão TEXT("/Game").
limitintegerPadrão 100.

Retorna: types, count.

foliage.list_spawner_types (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório.

Retorna: spawner.

foliage.list_spawners (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringContent folder to scan recursively. Padrão TEXT("/Game").

Retorna: spawners, count.

foliage.list_types (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringPadrão TEXT("/Game").
limitintegerPadrão 100.

Retorna: types, count.

foliage.list_volumes (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
includeBlockingbooleanInclude procedural blocking volumes. Padrão true.

Retorna: volumes, count, removedInstances.

foliage.move_instances (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
indicesarray of integerobrigató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.

ArgumentoTipoDescrição
typestringobrigatório. Registered source foliage type.
indicesarray of integerobrigatório. Instance indices.
targetTypestringobrigatório. Destination foliage type asset.

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

foliage.move_to_level (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringRegistered foliage type; empty moves every type.
indicesarray of integerInstance indices (with type); empty moves every instance.
levelstringobrigató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.

ArgumentoTipoDescrição
typestringobrigatório.
location{x,y,z}obrigatório.

Retorna: instance, count.

foliage.paint_actor (risco 2, altera, requer mundo, dryRun, smoke)​

Sem descrição.

ArgumentoTipoDescrição
actorstringobrigató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.

ArgumentoTipoDescriçã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.

ArgumentoTipoDescrição
center{x,y,z}Circle centre; z is the trace mid-height.
radiusnumberCircle 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.

ArgumentoTipoDescrição
start{x,y,z}Segment start.
end{x,y,z}Segment end.
spacingnumberDistance between samples (cm). Padrão 100.
jitternumberRandom 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.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type whose filters are evaluated.
location{x,y,z}Sample position; z is the trace mid-height.
traceHalfHeightnumberTrace 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.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
indicesarray of integerInstance indices; empty means every instance.
seedintegerRandom seed. Padrão 0.
randomYawbooleanReplace yaw with a random value. Padrão true.
scaleMinnumberMinimum uniform scale. Padrão 1.
scaleMaxnumberMaximum uniform scale. Padrão 1.

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

foliage.reapply_settings (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type.
indicesarray of integerInstance indices; empty means every instance.
seedintegerRandom seed. Padrão 0.
scalebooleanRe-roll scale from the scaling mode and ranges. Padrão true.
yawbooleanRe-roll yaw (0..360). Padrão true.
pitchbooleanRe-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.

ArgumentoTipoDescrição
typestringobrigatório.
offsetintegerPadrão 0.
limitintegerPadrão 100.

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

foliage.rebuild_all (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
allLevelsbooleanEvery loaded level instead of only the current level. Padrão false.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
allLevelsbooleanEvery loaded level instead of only the current level. Padrão false.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
typestringobrigatório.
offsetintegerPadrão 0.
limitintegerPadrão 100.

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

foliage.remove_filtered (risco 3, altera, destrutivo, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
inBoxbooleanRestrict 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).
radiusnumberSphere radius in centimetres; 0 disables the sphere test. Padrão 0.
minZnumberMinimum instance Z. Padrão -1.0e9.
maxZnumberMaximum instance Z. Padrão 1.0e9.
minScalenumberMinimum of the largest scale axis. Padrão 0.
maxScalenumberMaximum of the largest scale axis. Padrão 1.0e9.
limitintegerMaximum 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.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
min{x,y,z}World-space inclusive minimum bound.
max{x,y,z}World-space inclusive maximum bound.
limitintegerMaximum 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.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
center{x,y,z}World-space centre.
radiusnumberSphere radius in centimetres. Padrão 100.
limitintegerMaximum returned records. Padrão 100.

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

foliage.remove_indices (risco 3, altera, destrutivo, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
indicesarray of integerobrigatório.

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

foliage.remove_spawner_type (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório. Procedural foliage spawner asset.
typestringobrigatório. Foliage type asset.

Retorna: spawner.

foliage.remove_type_from_level (risco 3, altera, destrutivo, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: types, count.

foliage.remove_unused_level_types (risco 3, altera, destrutivo, requer mundo, dryRun, smoke)​

Sem descrição.

ArgumentoTipoDescrição
dryRunbooleanReport without applying. Padrão false.

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

foliage.remove_volume (risco 3, altera, destrutivo, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
volumesarray of stringobrigatório. Exact labels of ProceduralFoliageVolume or ProceduralFoliageBlockingVolume actors.
clearInstancesbooleanRemove 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.

ArgumentoTipoDescrição
typestringobrigatório.
namestringobrigatório.

Retorna: type.

foliage.replace_type (risco 3, altera, destrutivo, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
sourceTypestringobrigatório. Existing registered foliage type.
targetTypestringobrigatório. Destination foliage type asset.

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

foliage.replace_type_mesh (risco 2, altera, dryRun, smoke)​

Sem descrição.

ArgumentoTipoDescrição
folderstringContent folder to scan. Padrão TEXT("/Game").
fromMeshstringobrigatório. Static mesh currently used by the types.
toMeshstringobrigatório. Static mesh assigned instead.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
respectFiltersbooleanApply the type slope, height and landscape-layer filters to the traced hits. Padrão true.
dryRunbooleanRun 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.

ArgumentoTipoDescrição
typestringobrigatório.
indicesarray of integerobrigatório.
delta{x,y,z}

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

foliage.save_type (risco 2)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.

Retorna: type.

foliage.scale_instances (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
indicesarray of integerobrigató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.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
min{x,y,z}World-space minimum corner.
max{x,y,z}World-space maximum corner.
spacingnumberGrid spacing in centimetres. Padrão 100.
znumberPlacement height in centimetres. Padrão 0.
maxInstancesintegerMaximum instances to add. Padrão 1000.
seedintegerDeterministic yaw seed. Padrão 0.

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

foliage.scatter_poisson (risco 2, altera, requer mundo, dryRun, smoke)​

Sem descrição.

ArgumentoTipoDescrição
min{x,y,z}Rectangle minimum.
max{x,y,z}Rectangle maximum.
minDistancenumberMinimum distance between samples (cm). Padrão 100.
tracebooleanTrace 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.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
min{x,y,z}World-space minimum corner.
max{x,y,z}World-space maximum corner.
spacingnumberGrid spacing in centimetres. Padrão 100.
znumberPlacement height in centimetres. Padrão 0.
maxInstancesintegerMaximum instances to add. Padrão 1000.
seedintegerDeterministic yaw seed. Padrão 0.

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

foliage.select_instances (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
indicesarray of integerInstance indices.
replacebooleanReplace 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.

ArgumentoTipoDescrição
typestringobrigatório. Actor foliage type asset (FoliageType_Actor).
attachToBasebooleanAttach spawned actors to the component they were placed on. Padrão true.
staticMeshOnlyboolean5.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.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_affect_dynamic_indirect_lighting (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_align_max_angle (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberValue in degrees. Padrão 0.

Retorna: type, settings.

foliage.set_align_to_normal (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_average_normal (risco 2, altera, UE 5.0+, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanAverage the surface normal over several traces. Padrão true.
singleComponentbooleanOnly sample the component that was hit first. Padrão true.
sampleCountintegerNumber of normal samples (1..64). Padrão 10.

Retorna: type, settings.

foliage.set_average_spread_distance (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_cast_shadow (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_collision_enabled (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_collision_profile (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
profilestringobrigatório. Engine collision profile name.

Retorna: type.

foliage.set_collision_radius (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_collision_scale (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigató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.

ArgumentoTipoDescrição
typestringobrigatório. Instanced-static-mesh foliage type asset.
componentClassstringobrigatório. Class deriving from FoliageInstancedStaticMeshComponent.

Retorna: type, settings.

foliage.set_contact_shadow (risco 2, altera, UE 5.0+, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested state. Padrão true.

Retorna: type, settings.

foliage.set_cull_distance (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
minnumberInclusive lower value. Padrão 0.
maxnumberInclusive upper value. Padrão 0.

Retorna: type.

foliage.set_cull_distance_scaling (risco 2, altera, UE 5.2+, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested state. Padrão true.

Retorna: type, settings.

foliage.set_custom_data (risco 2, altera, UE 5.3+, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
indicesarray of integerobrigatório. Instance indices.
channelintegerCustom-data channel. Padrão 0.
valuenumberValue 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.

ArgumentoTipoDescrição
typestringobrigatório. Registered instanced-static-mesh foliage type.
countintegerCustom 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.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRender into the custom depth pass. Padrão true.
stencilValueintegerStencil value 0..255. Padrão 0.

Retorna: type, settings.

foliage.set_density (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_dynamic_shadow (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_evaluate_world_position_offset (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_ground_slope_filter (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
minnumberInclusive lower value. Padrão 0.
maxnumberInclusive upper value. Padrão 0.

Retorna: type.

foliage.set_height_filter (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
minnumberInclusive lower value. Padrão 0.
maxnumberInclusive upper value. Padrão 0.

Retorna: type.

foliage.set_include_in_hlod (risco 2, altera, UE 5.0+, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_initial_seed_density (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_instance_transform (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
indicesarray of integerobrigatório.
transformUeaFoliageTransformobrigatório.

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

foliage.set_instance_transforms (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type asset.
indicesarray of integerobrigatório. Instance indices.
transformsarray of UeaFoliageTransformobrigatório. One transform per index.

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

foliage.set_lighting_channels (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
channel0booleanLighting channel 0. Padrão true.
channel1booleanLighting channel 1. Padrão false.
channel2booleanLighting channel 2. Padrão false.

Retorna: type, settings.

foliage.set_lightmap_resolution (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
overridebooleanOverride the mesh lightmap resolution. Padrão true.
resolutionintegerLightmap resolution (4..4096) used when overriding. Padrão 64.

Retorna: type, settings.

foliage.set_material_override (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
slotintegerZero-based mesh material slot. Padrão 0.
materialstringobrigatório. Material-interface asset path.

Retorna: type.

foliage.set_max_age (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_max_initial_age (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_max_initial_seed_offset (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_mesh (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
meshstringobrigatório. Static mesh asset path.

Retorna: type.

foliage.set_minimum_layer_weight (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_mobility (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
mobilitystringobrigatório. Static, Stationary or Movable.

Retorna: type, settings.

foliage.set_nanite_material_override (risco 2, altera, UE 5.1+, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Instanced-static-mesh foliage type asset.
slotintegerZero-based slot. Padrão 0.
materialstringobrigatório. Material interface asset path.

Retorna: type, settings.

foliage.set_num_steps (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_overlap_priority (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_procedural_distribution (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
spreadVariancenumberVariance of the spread distance (centimetres). Padrão 150.
distributionSeedintegerSeed of the distribution. Padrão 0.
proceduralScaleMinnumberScale of the youngest instance. Padrão 1.
proceduralScaleMaxnumberScale of the oldest instance. Padrão 3.

Retorna: type, settings.

foliage.set_radius (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_random_pitch (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberValue in degrees. Padrão 0.

Retorna: type, settings.

foliage.set_random_yaw (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_receive_decals (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_runtime_virtual_texture (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_scalability (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
densityScalingbooleanScale instance density with foliage.DensityScale / scalability. Padrão false.
discardOnLoadbooleanDiscard 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.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_shade_growth (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
canGrowInShadebooleanInstances may grow in the shade of others. Padrão false.
spawnsInShadebooleanNew seeds may only spawn in shade. Padrão false.

Retorna: type, settings.

foliage.set_shade_radius (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuenumberNumeric value. Padrão 0.

Retorna: type.

foliage.set_shadow_cache_invalidation (risco 2, altera, UE 5.3+, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valuestringobrigató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.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested state. Padrão true.

Retorna: type, settings.

foliage.set_spawner (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório.
propertystringobrigatório.
valuestringobrigatório.

Retorna: spawner.

foliage.set_spawner_seed (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório. Procedural foliage spawner asset.
valueintegerInteger seed/count or centimetre tile size. Padrão 0.
assetUeaAssetInfo
randomSeedintegerPadrão 0.
tileSizenumberPadrão 0.
numUniqueTilesintegerPadrão 0.
typeCountintegerPadrão 0.
typesarray of stringFoliage type assets simulated by the spawner.

Retorna: spawner.

foliage.set_spawner_tile_size (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório. Procedural foliage spawner asset.
valueintegerInteger seed/count or centimetre tile size. Padrão 0.
assetUeaAssetInfo
randomSeedintegerPadrão 0.
tileSizenumberPadrão 0.
numUniqueTilesintegerPadrão 0.
typeCountintegerPadrão 0.
typesarray of stringFoliage type assets simulated by the spawner.

Retorna: spawner.

foliage.set_spawner_unique_tiles (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório. Procedural foliage spawner asset.
valueintegerInteger seed/count or centimetre tile size. Padrão 0.
assetUeaAssetInfo
randomSeedintegerPadrão 0.
tileSizenumberPadrão 0.
numUniqueTilesintegerPadrão 0.
typeCountintegerPadrão 0.
typesarray of stringFoliage type assets simulated by the spawner.

Retorna: spawner.

foliage.set_static_shadow (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_translucency_sort_priority (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valueintegerInteger value. Padrão 0.

Retorna: type, settings.

foliage.set_type (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
propertystringobrigatório.
valuestringobrigatório.

Retorna: type.

foliage.set_type_filters (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
landscapeLayersarray of string
exclusionLandscapeLayersarray of string
minimumLayerWeightstring
collisionWithWorldstring

Retorna: type.

foliage.set_type_instance_settings (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
propertystringobrigatório.
valuestringobrigatório.

Retorna: type.

foliage.set_type_placement (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
densitystring
radiusstring
zOffsetMinstring
zOffsetMaxstring
alignToNormalstring
randomYawstring
randomPitchAnglestring
groundSlopeMinstring
groundSlopeMaxstring

Retorna: type.

foliage.set_type_procedural (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
propertystringobrigatório.
valuestringobrigatório.

Retorna: type.

foliage.set_type_scaling (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório.
scalingstring
scaleXMinstring
scaleXMaxstring
scaleYMinstring
scaleYMaxstring
scaleZMinstring
scaleZMaxstring

Retorna: type.

foliage.set_use_as_occluder (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested setting state. Padrão true.

Retorna: type.

foliage.set_virtual_texture (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
texturesarray of stringRuntime virtual texture asset paths written to (replaces the list; empty clears it).
cullMipsintegerMips culled from the virtual texture pass (0..7). Padrão 0.
passTypestringMain-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.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
enabledbooleanRequested state. Padrão true.

Retorna: type, settings.

foliage.set_volume (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
volumestringobrigatório. Exact label of a ProceduralFoliageVolume.
spawnerstringNew spawner asset; empty keeps the current one.
setLocationbooleanMove 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.
tileOverlapnumberNew 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.

ArgumentoTipoDescrição
volumestringobrigatório. Exact label of a ProceduralFoliageVolume.
allowLandscapebooleanSpawn on landscapes. Padrão true.
allowBSPbooleanSpawn on BSP. Padrão true.
allowStaticMeshbooleanSpawn on static meshes. Padrão true.
allowTranslucentbooleanSpawn on translucent geometry. Padrão false.
allowFoliagebooleanSpawn on other foliage. Padrão false.

Retorna: volume.

foliage.set_wpo_disable_distance (risco 2, altera, UE 5.1+, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
valueintegerInteger value. Padrão 0.

Retorna: type, settings.

foliage.set_z_offset (risco 2, altera, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Foliage type asset.
minnumberInclusive lower value. Padrão 0.
maxnumberInclusive upper value. Padrão 0.

Retorna: type.

foliage.simulate (risco 2, altera, requer mundo, dryRun, smoke)​

Sem descrição.

ArgumentoTipoDescrição
volumestringobrigatório. Exact label of a ProceduralFoliageVolume.
respectFiltersbooleanApply the type slope, height and landscape-layer filters to the traced hits. Padrão true.
dryRunbooleanRun 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.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type.
indicesarray of integerInstance indices; empty means every instance.
alignToNormalbooleanAlign to the surface normal (keeps yaw). Padrão false.
traceHalfHeightnumberTrace 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.

ArgumentoTipoDescrição
folderstringPadrão TEXT("/Game").

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

foliage.thin_instances (risco 3, altera, destrutivo, requer mundo, dryRun, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigatório. Registered foliage type.
minDistancenumberMinimum distance (cm); 0 uses the type radius. Padrão 0.
dryRunbooleanReport 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.

ArgumentoTipoDescrição
typestringobrigatório. Registered instanced-static-mesh foliage type.
indicesarray of integerInstance indices; empty converts every instance (max 1000).
labelPrefixstringLabel prefix; actors are labelled _. Padrão TEXT("FoliageActor").
removeInstancesbooleanRemove the converted instances. Padrão false.

Retorna: actors, count, removed, total.

foliage.transform_region (risco 2, altera, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
typestringobrigató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.

ArgumentoTipoDescrição
folderstringPadrão TEXT("/Game").

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

foliage.validate_spawner (risco 0, smoke)​

Sem descrição.

ArgumentoTipoDescrição
spawnerstringobrigatório.

Retorna: spawner.

foliage.volume_stats (risco 0, requer mundo, smoke)​

Sem descrição.

ArgumentoTipoDescrição
volumestringobrigatório. Exact label of a ProceduralFoliageVolume.

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