User Tools

Site Tools


enable_effect

Enable Effect


Enables particle emission for the specified effect.

Signature:

enable_effect(effect)
ArgumentDescriptionTypeRequired
effectEffect to enable (e.g. entity[“effect_entity_id”]).EntityYes

If an effect is configured as “One-Shot”, this function can be used to trigger the particles to emit, for example after being added to a scene via the Add Effect function.

Example:

enable_effect(entity["torch"].effect["flame"]);

Results: The effect attached to the “flame” attach point of the entity with ID “torch” will be enabled, triggering its particles to start emitting.

Use the Enable Effect function to light a torch's flame or to shoot sparks from a broken machine when the player interacts with the respective object.


Editor Node:

enable_effect.txt · Last modified: 2024/01/30 16:55 by justin