gatos.render_fx_control

tool Debug and rendering

Edit live engine-plume, plume-trail, cloud, or terrain fields through FxCatalog.

Use when: Adjusting gatOS's runtime render editors without addressing /sim filesystem paths.
Availability: debug_namespace and the selected FX capability health latch.

Input

Field	Type	Requirement	Description
`family`	`string`	Required	engine_plume, plume_trail, clouds, or terrain.
`operation`	`string`	Required	set, reset, or plume_trail clear.
`entity`	`string \| null`	Optional · null	Family-specific entity selector.
`field`	`string \| null`	Optional · null	FxCatalog field name for set.
`value`	`number`	Optional · 0	Scalar field value.
`values`	`number[] \| null`	Optional · null	Vector/color field value.
`token`	`string \| null`	Optional · null	Alternate field token.

Operation call shapes

Choose an operation below. Its required payload and a complete call stay together—there is no second table to cross-reference.

`set`

Canonical action: debug.{family}_set

Validate and set one declared FxCatalog field. engine_plume entity is a template id; plume_trail entity is omitted; clouds entity is a body id; terrain uses a body id or an empty entity for wireframe.

Arguments for this operation

{ family, operation: "set", entity, field, value?: scalar, values?: vector }

Example

gatos.render_fx_control({"family":"engine_plume","operation":"set","entity":"MethaloxVac","field":"emission/brightness","value":35})

`reset`

Canonical action: debug.{family}_reset

Restore pristine session values for a template, body, or the global plume-trail renderer.

Arguments for this operation

{ family, operation: "reset", entity? }

Example

gatos.render_fx_control({"family":"clouds","operation":"reset","entity":"Kerbin"})

`clear`

Canonical action: debug.plumetrail_clear

Drop existing live trail geometry without changing renderer settings.

Arguments for this operation

{ family: "plume_trail", operation: "clear" }

Example

gatos.render_fx_control({"family":"plume_trail","operation":"clear"})

Call example

gatos.render_fx_control({"family":"engine_plume","operation":"set","entity":"Hunter:0","field":"size","value":1.4})

Result

FX command outcome; use get_runtime_state to inspect published editor state.

Errors

EACCES when debug is disabled; EOPNOTSUPP for a degraded reflector; EINVAL for unknown family/entity/field or invalid value.

Operational notes

FX changes are session-only and reset to captured pristine values.
Entity scope differs by family; discover it from runtime state and capabilities.