Differences

This shows you the differences between two versions of the page.

--- enable_effect [2024/01/30 15:18] – created justin
+++ enable_effect [2024/01/30 16:55] (current) – justin
@@ Line 1: / Line 1: @@
 ======Enable Effect======
 ----
-(WIP)
+Enables particle emission for the specified [[effect]].
 ====Signature:====
@@ Line 9: / Line 9: @@
 ^Argument^Description^Type^Required^
-|effect| |[[Entity]]|Yes|
+|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["flame_01"];
+enable_effect(entity["torch"].effect["flame"]);
 </code>
-//Results:// .
+//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...
+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>

RPG in a BoxOfficial Documentation