User Tools

Site Tools


enable_effect

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
enable_effect [2024/01/30 16:22] justinenable_effect [2024/01/30 16:55] (current) justin
Line 9: Line 9:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|effect|[[Effect]] to enable (as an [[entity]reference).|[[Entity]]|Yes|+|effect|[[Effect]] to enable (e.g. entity["effect_entity_id"]).|[[Entity]]|Yes|
  
 <WRAP center round info 100%> <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>+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:==== ====Example:====
Line 18: Line 19:
 enable_effect(entity["torch"].effect["flame"]); enable_effect(entity["torch"].effect["flame"]);
 </code> </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 emit.+//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%> <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> </WRAP>
  
enable_effect.1706660521.txt.gz · Last modified: 2024/01/30 16:22 by justin