Kit lighting
13 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 lighting. kit changes persisted project defaults that affect baked-lighting availability, reflection-capture
memory, and UE5 Lumen/VSM rendering. Use it after choosing the level's lighting design. It does not place lights or
build a level: use level. for that, component. for Blueprint component templates, and render./console. for
temporary renderer controls.
For an existing placed-light rig, use the rig audits to find budget, overlap, movable-shadow, and missing-IES risks.
Normalization, interior/exterior recipes, and quality tiers default to dryRun=true and apply coordinated changes
only after reviewing the returned per-light plan.
| Tool | Use |
|---|---|
lighting.get_static_defaults | Inspect static-lighting support, virtual-textured lightmaps, and reflection-capture resolution. |
lighting.set_static_defaults | Persist static-lighting and reflection-capture defaults. |
lighting.get_realtime_defaults | Inspect UE5 GI, reflection, virtual shadow map, and Lumen defaults. |
lighting.set_realtime_defaults | Persist UE5 Lumen/reflection/VSM defaults. |
Start by inspecting both groups:
lighting.get_static_defaults {}
lighting.get_realtime_defaults {}
For a baked-lighting project, confirm that static lighting is enabled before adding static or stationary lights and
running level.build_lighting. If reflection probes need more detail, set a power-of-two capture resolution, then
restart the editor and rebuild captures:
lighting.set_static_defaults {
"allowStaticLighting": "true",
"virtualTexturedLightmaps": "true",
"reflectionCaptureResolution": 512
}
level.recapture_reflections {}
For a UE5 dynamic-lighting project, write the project defaults before creating the final content. VSM is selected by
virtualShadowMaps; use false for conventional shadow maps. The following enables Lumen GI/reflections and asks
for hardware tracing where the target hardware and RHI support it:
lighting.set_realtime_defaults {
"globalIllumination": "lumen",
"reflections": "lumen",
"virtualShadowMaps": "true",
"lumenHardwareRayTracing": "true",
"lumenRayLightingMode": "surface_cache"
}
Then restart the editor. These are project config changes, so shader recompilation can follow. Build lighting only when the level still uses precomputed lighting; Lumen itself does not need a Lightmass build. Per-level artistic quality remains with a post-process volume:
level.add_post_process_volume { "name": "PP_Lighting", "unbound": true }
level.set_global_illumination { "target": "PP_Lighting", "method": "lumen", "lumenSceneLightingQuality": "4" }
level.set_reflection_method { "target": "PP_Lighting", "method": "lumen" }
lighting.get_realtime_defaults is hidden on UE 4.27. On custom UE5 builds, a missing renderer property is reported
in warnings; do not substitute a guessed CVar. hit_lighting_for_reflections is available from UE 5.5 onward;
older UE5 versions accept surface_cache or hit_lighting. The setter tools are intentionally not smoke-tested
because they write DefaultEngine.ini and can require restart, shader work, or a lighting rebuild.
To stage a rig to audit or tune, lighting.spawn_three_point_rig {namePrefix, target, distance} spawns
<prefix>_Key (spot), <prefix>_Fill (point) and <prefix>_Rim (spot) aimed at the target; pass the
prefix as nameContains to the rig audits, lighting.normalize_light_units, the recipes and
lighting.batch_set_quality_tier (all accept dryRun).
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
MaxAutoRiskrequieren"_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 argumentodryRun. smoke = cubierto poredit.self_test.
lighting.apply_exterior_rig_recipe (riesgo 2, modifica, requiere mundo, dryRun, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Prefix used to select existing rig light actors. |
keyIntensity | number | Primary-light intensity. Valor predeterminado 10000.0. |
fillIntensity | number | Fill-light intensity. Valor predeterminado 2000.0. |
dryRun | boolean | Preview without edits. Valor predeterminado true. |
Devuelve: count, changed, values, message.
lighting.apply_interior_rig_recipe (riesgo 2, modifica, requiere mundo, dryRun, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Prefix used to select existing rig light actors. |
keyIntensity | number | Primary-light intensity. Valor predeterminado 10000.0. |
fillIntensity | number | Fill-light intensity. Valor predeterminado 2000.0. |
dryRun | boolean | Preview without edits. Valor predeterminado true. |
Devuelve: count, changed, values, message.
lighting.audit_light_budget (riesgo 0, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Optional light actor-name substring. |
limit | integer | Maximum lights reported. Valor predeterminado 100. |
distance | number | Distance threshold in centimetres. Valor predeterminado 1000.0. |
Devuelve: count, changed, values, message.
lighting.batch_set_quality_tier (riesgo 2, modifica, requiere mundo, dryRun, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
tier | string | obligatorio. low, medium, or high. |
nameContains | string | Optional light actor-name substring. |
dryRun | boolean | Preview without edits. Valor predeterminado true. |
Devuelve: count, changed, values, message.
lighting.find_missing_ies_assets (riesgo 0, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Optional light actor-name substring. |
limit | integer | Maximum lights reported. Valor predeterminado 100. |
distance | number | Distance threshold in centimetres. Valor predeterminado 1000.0. |
Devuelve: count, changed, values, message.
lighting.find_overlapping_lights (riesgo 0, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Optional light actor-name substring. |
limit | integer | Maximum lights reported. Valor predeterminado 100. |
distance | number | Distance threshold in centimetres. Valor predeterminado 1000.0. |
Devuelve: count, changed, values, message.
lighting.find_shadow_cost_risks (riesgo 0, requiere mundo, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Optional light actor-name substring. |
limit | integer | Maximum lights reported. Valor predeterminado 100. |
distance | number | Distance threshold in centimetres. Valor predeterminado 1000.0. |
Devuelve: count, changed, values, message.
lighting.get_realtime_defaults (riesgo 0, UE 5.0+, smoke)
Gets the UE5 dynamic GI, reflection, virtual-shadow-map and Lumen defaults.
Sin argumentos.
Devuelve: settings, warnings, restartRequired.
lighting.get_static_defaults (riesgo 0, smoke)
Gets static-lighting, virtual-lightmap and reflection-capture project defaults.
Sin argumentos.
Devuelve: settings, warnings, restartRequired.
lighting.normalize_light_units (riesgo 2, modifica, requiere mundo, dryRun, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Optional light actor-name substring. |
intensity | number | obligatorio. Target intensity in the light's current unit. |
dryRun | boolean | Preview without edits. Valor predeterminado true. |
Devuelve: count, changed, values, message.
lighting.set_realtime_defaults (riesgo 4, modifica, UE 5.0+)
Persists UE5 Lumen, reflection and virtual-shadow-map defaults. Restart and shader rebuilds can be required.
| Argumento | Tipo | Descripción |
|---|---|---|
globalIllumination | string | Dynamic GI: none, lumen or ssgi. |
reflections | string | Reflection method: none, lumen or ssr. |
virtualShadowMaps | string | true selects virtual shadow maps; false selects conventional shadow maps; empty keeps the setting. |
lumenHardwareRayTracing | string | Use hardware ray tracing for Lumen where the RHI and hardware support it. Empty keeps the setting. |
lumenRayLightingMode | string | Lumen hardware ray lighting: surface_cache, hit_lighting or hit_lighting_for_reflections. Empty keeps it. |
Devuelve: settings, warnings, restartRequired.
lighting.set_static_defaults (riesgo 4, modifica)
Persists static-lighting, virtual-lightmap and reflection-capture project defaults. Restart and shader/light rebuilds can be required.
| Argumento | Tipo | Descripción |
|---|---|---|
allowStaticLighting | string | Whether projects may generate/use static lighting. Empty keeps the current value. |
virtualTexturedLightmaps | string | Whether baked lightmaps use virtual-texture streaming. Empty keeps the current value. |
reflectionCaptureResolution | integer | Reflection-capture cubemap edge resolution, a power of two from 16 through 4096; -1 keeps it. Valor predeterminado -1. |
Devuelve: settings, warnings, restartRequired.
lighting.spawn_three_point_rig (riesgo 2, modifica, requiere mundo, smoke)
Spawns a key (spot), fill (point) and rim (spot) light around a subject location, all aimed at it; returns the spawned labels.
| Argumento | Tipo | Descripción |
|---|---|---|
namePrefix | string | obligatorio. Label prefix; lights are labelled |
target | {x,y,z} | Subject location in centimetres the lights aim at. |
distance | number | Distance from the subject in centimetres. Valor predeterminado 400.0. |
keyIntensity | number | Key spot light intensity (engine default units). Valor predeterminado 5000.0. |
fillIntensity | number | Fill point light intensity. Valor predeterminado 1500.0. |
rimIntensity | number | Rim spot light intensity. Valor predeterminado 3000.0. |
mobility | string | Mobility of the spawned lights: movable, stationary or static. Valor predeterminado TEXT("movable"). |
Devuelve: count, changed, values, message.