RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Enable Effect======
----
Enables particle emission for the specified [[effect]].

====Signature:====
<code python>
enable_effect(effect)
</code>

^Argument^Description^Type^Required^
|effect|[[Effect]] to enable (e.g. entity["effect_entity_id"]).|[[Entity]]|Yes|

<WRAP center round info 100%>
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.
</WRAP>

====Example:====
<code bauxite>
enable_effect(entity["torch"].effect["flame"]);
</code>
//Results:// The [[effect]] attached to the "flame" [[attach_points|attach point]] of the [[entity]] with ID "torch" will be enabled, triggering its particles to start emitting.

<WRAP center round tip 100%>
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]].
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:enable_effect_node.png?nolink|}}
</WRAP>

<WRAP half column>
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation