Saltar al contenido principal

Kit foliage

184 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.

Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en tools/list).

Guía​

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.

Herramientas​

Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de MaxAutoRisk requieren "_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumento dryRun. smoke = cubierto por edit.self_test.

foliage.add_blocking_volume (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
labelstringobligatorio. 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). Valor predeterminado FUeaVec3(200,200,500).

Devuelve: volume.

foliage.add_instance (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
transformsarray of UeaFoliageTransformobligatorio.

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

foliage.add_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
transformsarray of UeaFoliageTransformobligatorio.

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

foliage.add_spawner_type (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio. Procedural foliage spawner asset.
typestringobligatorio. Foliage type asset.

Devuelve: spawner.

foliage.add_type_to_level (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: types, count.

foliage.add_volume (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
labelstringobligatorio. Actor label (must be unused).
spawnerstringobligatorio. Procedural foliage spawner asset.
location{x,y,z}Volume centre.
extent{x,y,z}Box half size (cm). Valor predeterminado FUeaVec3(1000,1000,500).
tileOverlapnumberOverlap between simulation tiles (cm). Valor predeterminado 0.

Devuelve: volume.

foliage.audit (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringValor predeterminado TEXT("/Game").

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

foliage.audit_collision (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
minInstancesintegerOnly flag types with at least this many instances in the editor world. Valor predeterminado 0.

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

foliage.audit_cull_distance (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
maxEndDistanceintegerFlag end distances above this value (0 flags only never-culled types). Valor predeterminado 0.

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

foliage.audit_density (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
maxDensitynumberDensity (instances per 1000x1000 cm) above which a type is flagged. Valor predeterminado 100.

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

foliage.audit_shadows (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
minInstancesintegerOnly flag types with at least this many instances in the editor world. Valor predeterminado 0.

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

foliage.batch_set_align_to_normal (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_collision (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
profilestringobligatorio. Collision profile name.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_contact_shadow (riesgo 2, modifica, UE 5.0+, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_cull_distance (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
startDistanceintegerCull start distance (cm). Valor predeterminado 0.
endDistanceintegerCull end distance (cm). Valor predeterminado 10000.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_decals (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_density (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuenumberValue applied to every matching foliage type. Valor predeterminado 0.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_density_scaling (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_distance_field (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_dynamic_shadow (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_hlod (riesgo 2, modifica, UE 5.0+, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_indirect_lighting (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_mobility (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
mobilitystringobligatorio. Static, Stationary or Movable.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_occluder (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_radius (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuenumberValue applied to every matching foliage type. Valor predeterminado 0.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_random_yaw (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_scale (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
minnumberMinimum uniform scale. Valor predeterminado 1.
maxnumberMaximum uniform scale. Valor predeterminado 1.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_shadows (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_static_shadow (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.batch_set_wpo (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
valuebooleanValue applied to every type. Valor predeterminado true.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.cleanup_invalid (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
allLevelsbooleanEvery loaded level instead of only the current level. Valor predeterminado false.
dryRunbooleanReport without applying (clean-up tools). Valor predeterminado false.

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

foliage.clear_selection (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
offsetintegerValor predeterminado 0.
limitintegerValor predeterminado 100.

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

foliage.clear_volume (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
volumestringobligatorio. Exact label of a ProceduralFoliageVolume.

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

foliage.count (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
offsetintegerValor predeterminado 0.
limitintegerValor predeterminado 100.

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

foliage.create_actor_type (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
actorClassstringobligatorio.

Devuelve: type.

foliage.create_ground (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
labelstringActor label; an existing static-mesh actor with this label is reused and resized. Valor predeterminado 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. Valor predeterminado FUeaVec3(1000,1000,0).

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

foliage.create_spawner (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
randomSeedintegerValor predeterminado 0.
tileSizenumberValor predeterminado 10000.
numUniqueTilesintegerValor predeterminado 1.

Devuelve: spawner.

foliage.create_type (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringobligatorio.
namestringobligatorio.
meshstringobligatorio.

Devuelve: type.

foliage.delete_type (riesgo 3, modifica, destructivo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

foliage.duplicate_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
indicesarray of integerobligatorio. Source instance indices.
offset{x,y,z}World offset of the copies.

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

foliage.duplicate_type (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
folderstringobligatorio.
namestringobligatorio.

Devuelve: type.

foliage.export_instances (riesgo 1, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringRegistered foliage type; empty exports every type of the current level.
filestringobligatorio. Bare file name (letters, digits, _ and -), without extension.

Devuelve: path, instances, types.

foliage.find_instances (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
inBoxbooleanRestrict to the min/max box. Valor predeterminado 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. Valor predeterminado 0.
minZnumberMinimum instance Z. Valor predeterminado -1.0e9.
maxZnumberMaximum instance Z. Valor predeterminado 1.0e9.
minScalenumberMinimum of the largest scale axis. Valor predeterminado 0.
maxScalenumberMaximum of the largest scale axis. Valor predeterminado 1.0e9.
limitintegerMaximum returned records. Valor predeterminado 100.

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

foliage.find_types_by_mesh (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
meshstringobligatorio.
folderstringValor predeterminado TEXT("/Game").

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

foliage.find_unused_types (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringValor predeterminado TEXT("/Game").

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

foliage.from_static_mesh_actors (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
actorsarray of stringobligatorio. Exact labels of StaticMeshActors whose mesh equals the type mesh.
typestringobligatorio. Instanced-static-mesh foliage type receiving the instances.
deleteActorsbooleanDelete the actors after conversion. Valor predeterminado false.

Devuelve: actors, count, removed, total.

foliage.get_bounds (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
offsetintegerValor predeterminado 0.
limitintegerValor predeterminado 100.

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

foliage.get_collision (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type, settings.

foliage.get_culling (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type, settings.

foliage.get_custom_data (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
indexintegerValor predeterminado -1.

Devuelve: index, channels, values, component.

foliage.get_instance (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
indexintegerValor predeterminado -1.

Devuelve: instance, count.

foliage.get_instances (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
offsetintegerValor predeterminado 0.
limitintegerValor predeterminado 100.

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

foliage.get_instances_in_box (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. 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. Valor predeterminado 100.

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

foliage.get_instances_in_sphere (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
center{x,y,z}World-space centre.
radiusnumberSphere radius in centimetres. Valor predeterminado 100.
limitintegerMaximum returned records. Valor predeterminado 100.

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

foliage.get_lighting (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type, settings.

foliage.get_placement (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type, settings.

foliage.get_procedural_settings (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type, settings.

foliage.get_rendering (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type, settings.

foliage.get_scaling (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type, settings.

foliage.get_selected_instances (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
offsetintegerValor predeterminado 0.
limitintegerValor predeterminado 100.

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

foliage.get_spawner (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio.

Devuelve: spawner.

foliage.get_type (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type.

foliage.get_volume (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
volumestringobligatorio. Exact label of a ProceduralFoliageVolume.

Devuelve: volume.

foliage.import_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
filestringobligatorio. 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. Valor predeterminado false.

Devuelve: path, instances, types.

foliage.list_foliage_actors (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
allLevelsbooleanEvery loaded level instead of only the current level. Valor predeterminado false.
dryRunbooleanReport without applying (clean-up tools). Valor predeterminado false.

Devuelve: actors, count, instances.

foliage.list_level_types (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringValor predeterminado TEXT("/Game").
limitintegerValor predeterminado 100.

Devuelve: types, count.

foliage.list_spawner_types (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio.

Devuelve: spawner.

foliage.list_spawners (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan recursively. Valor predeterminado TEXT("/Game").

Devuelve: spawners, count.

foliage.list_types (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringValor predeterminado TEXT("/Game").
limitintegerValor predeterminado 100.

Devuelve: types, count.

foliage.list_volumes (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
includeBlockingbooleanInclude procedural blocking volumes. Valor predeterminado true.

Devuelve: volumes, count, removedInstances.

foliage.move_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
indicesarray of integerobligatorio.
offset{x,y,z}

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

foliage.move_instances_to_type (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered source foliage type.
indicesarray of integerobligatorio. Instance indices.
targetTypestringobligatorio. Destination foliage type asset.

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

foliage.move_to_level (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringRegistered foliage type; empty moves every type.
indicesarray of integerInstance indices (with type); empty moves every instance.
levelstringobligatorio. Target level: "persistent", the package short name or the full package name of a loaded level.

Devuelve: sourceLevel, targetLevel, moved, note.

foliage.nearest_instance (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
location{x,y,z}obligatorio.

Devuelve: instance, count.

foliage.paint_actor (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
actorstringobligatorio. Actor label or name whose surfaces receive instances.

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

foliage.paint_box (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
min{x,y,z}Box minimum (x, y; z averaged with max as the trace mid-height).
max{x,y,z}Box maximum.

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

foliage.paint_circle (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
center{x,y,z}Circle centre; z is the trace mid-height.
radiusnumberCircle radius (cm). Valor predeterminado 500.

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

foliage.paint_line (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
start{x,y,z}Segment start.
end{x,y,z}Segment end.
spacingnumberDistance between samples (cm). Valor predeterminado 100.
jitternumberRandom XY offset of each sample (cm). Valor predeterminado 0.

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

foliage.preview_trace (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type whose filters are evaluated.
location{x,y,z}Sample position; z is the trace mid-height.
traceHalfHeightnumberTrace half height (cm). Valor predeterminado 5000.

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

foliage.randomize_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
indicesarray of integerInstance indices; empty means every instance.
seedintegerRandom seed. Valor predeterminado 0.
randomYawbooleanReplace yaw with a random value. Valor predeterminado true.
scaleMinnumberMinimum uniform scale. Valor predeterminado 1.
scaleMaxnumberMaximum uniform scale. Valor predeterminado 1.

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

foliage.reapply_settings (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type.
indicesarray of integerInstance indices; empty means every instance.
seedintegerRandom seed. Valor predeterminado 0.
scalebooleanRe-roll scale from the scaling mode and ranges. Valor predeterminado true.
yawbooleanRe-roll yaw (0..360). Valor predeterminado true.
pitchbooleanRe-roll pitch within RandomPitchAngle. Valor predeterminado false.

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

foliage.rebuild (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
offsetintegerValor predeterminado 0.
limitintegerValor predeterminado 100.

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

foliage.rebuild_all (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
allLevelsbooleanEvery loaded level instead of only the current level. Valor predeterminado false.
dryRunbooleanReport without applying (clean-up tools). Valor predeterminado false.

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

foliage.remove_all (riesgo 3, modifica, destructivo, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
allLevelsbooleanEvery loaded level instead of only the current level. Valor predeterminado false.
dryRunbooleanReport without applying (clean-up tools). Valor predeterminado false.

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

foliage.remove_by_type (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
offsetintegerValor predeterminado 0.
limitintegerValor predeterminado 100.

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

foliage.remove_filtered (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
inBoxbooleanRestrict to the min/max box. Valor predeterminado 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. Valor predeterminado 0.
minZnumberMinimum instance Z. Valor predeterminado -1.0e9.
maxZnumberMaximum instance Z. Valor predeterminado 1.0e9.
minScalenumberMinimum of the largest scale axis. Valor predeterminado 0.
maxScalenumberMaximum of the largest scale axis. Valor predeterminado 1.0e9.
limitintegerMaximum returned records. Valor predeterminado 100.

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

foliage.remove_in_box (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. 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. Valor predeterminado 100.

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

foliage.remove_in_sphere (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
center{x,y,z}World-space centre.
radiusnumberSphere radius in centimetres. Valor predeterminado 100.
limitintegerMaximum returned records. Valor predeterminado 100.

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

foliage.remove_indices (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
indicesarray of integerobligatorio.

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

foliage.remove_spawner_type (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio. Procedural foliage spawner asset.
typestringobligatorio. Foliage type asset.

Devuelve: spawner.

foliage.remove_type_from_level (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: types, count.

foliage.remove_unused_level_types (riesgo 3, modifica, destructivo, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
dryRunbooleanReport without applying. Valor predeterminado false.

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

foliage.remove_volume (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
volumesarray of stringobligatorio. Exact labels of ProceduralFoliageVolume or ProceduralFoliageBlockingVolume actors.
clearInstancesbooleanRemove the instances spawned by each procedural volume first. Valor predeterminado true.

Devuelve: volumes, count, removedInstances.

foliage.rename_type (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
namestringobligatorio.

Devuelve: type.

foliage.replace_type (riesgo 3, modifica, destructivo, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
sourceTypestringobligatorio. Existing registered foliage type.
targetTypestringobligatorio. Destination foliage type asset.

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

foliage.replace_type_mesh (riesgo 2, modifica, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringContent folder to scan. Valor predeterminado TEXT("/Game").
fromMeshstringobligatorio. Static mesh currently used by the types.
toMeshstringobligatorio. Static mesh assigned instead.
dryRunbooleanReport the per-type changes without applying them. Valor predeterminado false.

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

foliage.resimulate_all (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
respectFiltersbooleanApply the type slope, height and landscape-layer filters to the traced hits. Valor predeterminado true.
dryRunbooleanRun the simulations and traces without replacing instances. Valor predeterminado false.

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

foliage.rotate_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
indicesarray of integerobligatorio.
delta{x,y,z}

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

foliage.save_type (riesgo 2)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.

Devuelve: type.

foliage.scale_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
indicesarray of integerobligatorio.
multiplier{x,y,z}Valor predeterminado FUeaVec3(1,1,1).

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

foliage.scatter_grid (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
min{x,y,z}World-space minimum corner.
max{x,y,z}World-space maximum corner.
spacingnumberGrid spacing in centimetres. Valor predeterminado 100.
znumberPlacement height in centimetres. Valor predeterminado 0.
maxInstancesintegerMaximum instances to add. Valor predeterminado 1000.
seedintegerDeterministic yaw seed. Valor predeterminado 0.

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

foliage.scatter_poisson (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
min{x,y,z}Rectangle minimum.
max{x,y,z}Rectangle maximum.
minDistancenumberMinimum distance between samples (cm). Valor predeterminado 100.
tracebooleanTrace to the surface; false places at z (Min.z) without filters. Valor predeterminado true.

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

foliage.scatter_random (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
min{x,y,z}World-space minimum corner.
max{x,y,z}World-space maximum corner.
spacingnumberGrid spacing in centimetres. Valor predeterminado 100.
znumberPlacement height in centimetres. Valor predeterminado 0.
maxInstancesintegerMaximum instances to add. Valor predeterminado 1000.
seedintegerDeterministic yaw seed. Valor predeterminado 0.

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

foliage.select_instances (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
indicesarray of integerInstance indices.
replacebooleanReplace selection when true; otherwise add. Valor predeterminado true.

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

foliage.set_actor_type_settings (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Actor foliage type asset (FoliageType_Actor).
attachToBasebooleanAttach spawned actors to the component they were placed on. Valor predeterminado true.
staticMeshOnlyboolean5.0+: render the actor's static meshes as instances instead of spawning actors (ignored with a note on 4.27). Valor predeterminado false.

Devuelve: type, settings.

foliage.set_affect_distance_field (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_affect_dynamic_indirect_lighting (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_align_max_angle (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberValue in degrees. Valor predeterminado 0.

Devuelve: type, settings.

foliage.set_align_to_normal (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_average_normal (riesgo 2, modifica, UE 5.0+, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanAverage the surface normal over several traces. Valor predeterminado true.
singleComponentbooleanOnly sample the component that was hit first. Valor predeterminado true.
sampleCountintegerNumber of normal samples (1..64). Valor predeterminado 10.

Devuelve: type, settings.

foliage.set_average_spread_distance (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_cast_shadow (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_collision_enabled (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_collision_profile (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
profilestringobligatorio. Engine collision profile name.

Devuelve: type.

foliage.set_collision_radius (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_collision_scale (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
scale{x,y,z}Scale applied to the mesh bounds in the world-collision test. Valor predeterminado FUeaVec3(0.9,0.9,0.9).

Devuelve: type, settings.

foliage.set_component_class (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Instanced-static-mesh foliage type asset.
componentClassstringobligatorio. Class deriving from FoliageInstancedStaticMeshComponent.

Devuelve: type, settings.

foliage.set_contact_shadow (riesgo 2, modifica, UE 5.0+, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested state. Valor predeterminado true.

Devuelve: type, settings.

foliage.set_cull_distance (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
minnumberInclusive lower value. Valor predeterminado 0.
maxnumberInclusive upper value. Valor predeterminado 0.

Devuelve: type.

foliage.set_cull_distance_scaling (riesgo 2, modifica, UE 5.2+, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested state. Valor predeterminado true.

Devuelve: type, settings.

foliage.set_custom_data (riesgo 2, modifica, UE 5.3+, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
indicesarray of integerobligatorio. Instance indices.
channelintegerCustom-data channel. Valor predeterminado 0.
valuenumberValue for the channel. Valor predeterminado 0.

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

foliage.set_custom_data_channels (riesgo 2, modifica, UE 5.3+, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered instanced-static-mesh foliage type.
countintegerCustom data floats per instance (0..32). Valor predeterminado 1.

Devuelve: index, channels, values, component.

foliage.set_custom_depth (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRender into the custom depth pass. Valor predeterminado true.
stencilValueintegerStencil value 0..255. Valor predeterminado 0.

Devuelve: type, settings.

foliage.set_density (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_dynamic_shadow (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_evaluate_world_position_offset (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_ground_slope_filter (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
minnumberInclusive lower value. Valor predeterminado 0.
maxnumberInclusive upper value. Valor predeterminado 0.

Devuelve: type.

foliage.set_height_filter (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
minnumberInclusive lower value. Valor predeterminado 0.
maxnumberInclusive upper value. Valor predeterminado 0.

Devuelve: type.

foliage.set_include_in_hlod (riesgo 2, modifica, UE 5.0+, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_initial_seed_density (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_instance_transform (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
indicesarray of integerobligatorio.
transformUeaFoliageTransformobligatorio.

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

foliage.set_instance_transforms (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type asset.
indicesarray of integerobligatorio. Instance indices.
transformsarray of UeaFoliageTransformobligatorio. One transform per index.

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

foliage.set_lighting_channels (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
channel0booleanLighting channel 0. Valor predeterminado true.
channel1booleanLighting channel 1. Valor predeterminado false.
channel2booleanLighting channel 2. Valor predeterminado false.

Devuelve: type, settings.

foliage.set_lightmap_resolution (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
overridebooleanOverride the mesh lightmap resolution. Valor predeterminado true.
resolutionintegerLightmap resolution (4..4096) used when overriding. Valor predeterminado 64.

Devuelve: type, settings.

foliage.set_material_override (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
slotintegerZero-based mesh material slot. Valor predeterminado 0.
materialstringobligatorio. Material-interface asset path.

Devuelve: type.

foliage.set_max_age (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_max_initial_age (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_max_initial_seed_offset (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_mesh (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
meshstringobligatorio. Static mesh asset path.

Devuelve: type.

foliage.set_minimum_layer_weight (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_mobility (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
mobilitystringobligatorio. Static, Stationary or Movable.

Devuelve: type, settings.

foliage.set_nanite_material_override (riesgo 2, modifica, UE 5.1+, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Instanced-static-mesh foliage type asset.
slotintegerZero-based slot. Valor predeterminado 0.
materialstringobligatorio. Material interface asset path.

Devuelve: type, settings.

foliage.set_num_steps (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_overlap_priority (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_procedural_distribution (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
spreadVariancenumberVariance of the spread distance (centimetres). Valor predeterminado 150.
distributionSeedintegerSeed of the distribution. Valor predeterminado 0.
proceduralScaleMinnumberScale of the youngest instance. Valor predeterminado 1.
proceduralScaleMaxnumberScale of the oldest instance. Valor predeterminado 3.

Devuelve: type, settings.

foliage.set_radius (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_random_pitch (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberValue in degrees. Valor predeterminado 0.

Devuelve: type, settings.

foliage.set_random_yaw (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_receive_decals (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_runtime_virtual_texture (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_scalability (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
densityScalingbooleanScale instance density with foliage.DensityScale / scalability. Valor predeterminado false.
discardOnLoadbooleanDiscard instances on load when density scaling culls them. Valor predeterminado false.

Devuelve: type, settings.

foliage.set_seeds_per_step (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_shade_growth (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
canGrowInShadebooleanInstances may grow in the shade of others. Valor predeterminado false.
spawnsInShadebooleanNew seeds may only spawn in shade. Valor predeterminado false.

Devuelve: type, settings.

foliage.set_shade_radius (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuenumberNumeric value. Valor predeterminado 0.

Devuelve: type.

foliage.set_shadow_cache_invalidation (riesgo 2, modifica, UE 5.3+, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valuestringobligatorio. Enum entry name (e.g. Auto, Always, Rigid, Static).

Devuelve: type, settings.

foliage.set_shadow_two_sided (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested state. Valor predeterminado true.

Devuelve: type, settings.

foliage.set_spawner (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio.
propertystringobligatorio.
valuestringobligatorio.

Devuelve: spawner.

foliage.set_spawner_seed (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio. Procedural foliage spawner asset.
valueintegerInteger seed/count or centimetre tile size. Valor predeterminado 0.
assetUeaAssetInfo
randomSeedintegerValor predeterminado 0.
tileSizenumberValor predeterminado 0.
numUniqueTilesintegerValor predeterminado 0.
typeCountintegerValor predeterminado 0.
typesarray of stringFoliage type assets simulated by the spawner.

Devuelve: spawner.

foliage.set_spawner_tile_size (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio. Procedural foliage spawner asset.
valueintegerInteger seed/count or centimetre tile size. Valor predeterminado 0.
assetUeaAssetInfo
randomSeedintegerValor predeterminado 0.
tileSizenumberValor predeterminado 0.
numUniqueTilesintegerValor predeterminado 0.
typeCountintegerValor predeterminado 0.
typesarray of stringFoliage type assets simulated by the spawner.

Devuelve: spawner.

foliage.set_spawner_unique_tiles (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio. Procedural foliage spawner asset.
valueintegerInteger seed/count or centimetre tile size. Valor predeterminado 0.
assetUeaAssetInfo
randomSeedintegerValor predeterminado 0.
tileSizenumberValor predeterminado 0.
numUniqueTilesintegerValor predeterminado 0.
typeCountintegerValor predeterminado 0.
typesarray of stringFoliage type assets simulated by the spawner.

Devuelve: spawner.

foliage.set_static_shadow (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_translucency_sort_priority (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valueintegerInteger value. Valor predeterminado 0.

Devuelve: type, settings.

foliage.set_type (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
propertystringobligatorio.
valuestringobligatorio.

Devuelve: type.

foliage.set_type_filters (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
landscapeLayersarray of string
exclusionLandscapeLayersarray of string
minimumLayerWeightstring
collisionWithWorldstring

Devuelve: type.

foliage.set_type_instance_settings (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
propertystringobligatorio.
valuestringobligatorio.

Devuelve: type.

foliage.set_type_placement (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
densitystring
radiusstring
zOffsetMinstring
zOffsetMaxstring
alignToNormalstring
randomYawstring
randomPitchAnglestring
groundSlopeMinstring
groundSlopeMaxstring

Devuelve: type.

foliage.set_type_procedural (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
propertystringobligatorio.
valuestringobligatorio.

Devuelve: type.

foliage.set_type_scaling (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio.
scalingstring
scaleXMinstring
scaleXMaxstring
scaleYMinstring
scaleYMaxstring
scaleZMinstring
scaleZMaxstring

Devuelve: type.

foliage.set_use_as_occluder (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested setting state. Valor predeterminado true.

Devuelve: type.

foliage.set_virtual_texture (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. 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). Valor predeterminado 0.
passTypestringMain-pass rendering: Never, Exclusive or Always. Valor predeterminado TEXT("Exclusive").

Devuelve: type, settings.

foliage.set_visible_in_ray_tracing (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
enabledbooleanRequested state. Valor predeterminado true.

Devuelve: type, settings.

foliage.set_volume (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
volumestringobligatorio. Exact label of a ProceduralFoliageVolume.
spawnerstringNew spawner asset; empty keeps the current one.
setLocationbooleanMove the volume to location. Valor predeterminado 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. Valor predeterminado -1.

Devuelve: volume.

foliage.set_volume_filters (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
volumestringobligatorio. Exact label of a ProceduralFoliageVolume.
allowLandscapebooleanSpawn on landscapes. Valor predeterminado true.
allowBSPbooleanSpawn on BSP. Valor predeterminado true.
allowStaticMeshbooleanSpawn on static meshes. Valor predeterminado true.
allowTranslucentbooleanSpawn on translucent geometry. Valor predeterminado false.
allowFoliagebooleanSpawn on other foliage. Valor predeterminado false.

Devuelve: volume.

foliage.set_wpo_disable_distance (riesgo 2, modifica, UE 5.1+, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
valueintegerInteger value. Valor predeterminado 0.

Devuelve: type, settings.

foliage.set_z_offset (riesgo 2, modifica, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Foliage type asset.
minnumberInclusive lower value. Valor predeterminado 0.
maxnumberInclusive upper value. Valor predeterminado 0.

Devuelve: type.

foliage.simulate (riesgo 2, modifica, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
volumestringobligatorio. Exact label of a ProceduralFoliageVolume.
respectFiltersbooleanApply the type slope, height and landscape-layer filters to the traced hits. Valor predeterminado true.
dryRunbooleanRun the simulation and traces without replacing the volume's instances. Valor predeterminado false.

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

foliage.snap_to_ground (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type.
indicesarray of integerInstance indices; empty means every instance.
alignToNormalbooleanAlign to the surface normal (keeps yaw). Valor predeterminado false.
traceHalfHeightnumberTrace half height (cm). Valor predeterminado 5000.

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

foliage.stats (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringValor predeterminado TEXT("/Game").

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

foliage.thin_instances (riesgo 3, modifica, destructivo, requiere mundo, dryRun, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered foliage type.
minDistancenumberMinimum distance (cm); 0 uses the type radius. Valor predeterminado 0.
dryRunbooleanReport without removing. Valor predeterminado false.

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

foliage.to_static_mesh_actors (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. Registered instanced-static-mesh foliage type.
indicesarray of integerInstance indices; empty converts every instance (max 1000).
labelPrefixstringLabel prefix; actors are labelled _. Valor predeterminado TEXT("FoliageActor").
removeInstancesbooleanRemove the converted instances. Valor predeterminado false.

Devuelve: actors, count, removed, total.

foliage.transform_region (riesgo 2, modifica, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
typestringobligatorio. 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. Valor predeterminado FUeaVec3(1,1,1).

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

foliage.validate (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
folderstringValor predeterminado TEXT("/Game").

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

foliage.validate_spawner (riesgo 0, smoke)​

Sin descripción.

ArgumentoTipoDescripción
spawnerstringobligatorio.

Devuelve: spawner.

foliage.volume_stats (riesgo 0, requiere mundo, smoke)​

Sin descripción.

ArgumentoTipoDescripción
volumestringobligatorio. Exact label of a ProceduralFoliageVolume.

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