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.

======Add Effect======
----
Adds an [[effect]] at the specified [[coordinate]] within the [[map]]. The [[entity]] ID is optional and will be assigned to the new [[effect]] if supplied. If the [[effect]] is configured as "One Shot", it will need to be enabled via the [[Enable Effect]] function once it has been added to the [[map]].

====Signature:====
<code python>
add_effect(effect_name, coordinate, entity_id)
</code>

^Argument^Description^Type^Required^
|effect_name|Particle effect to use for the new [[effect]].|[[string|String]]|Yes|
|coordinate|[[Coordinate]] where the [[effect]] will be placed.|[[coordinate|Coordinate]]|Yes|
|entity_id|Unique [[entity|entity]] ID that will be assigned.|[[string|String]]|No|

<WRAP center round info 100%>
The [[remove_entity|Remove Entity]] function can be triggered later to remove an [[effect]] that was previously added to the scene with the Add Effect function.
</WRAP>

^Return Value^Description^Type^
|Effect Added|Returns a reference to the [[effect]] that was added.|[[Entity]]|

====Example:====
<code bauxite>
add_effect("flame", coord[0, 0, 0], "flame_01");
</code>
//Results:// A flame [[effect]] will be added to the [[map|map]] at the XYZ [[coordinate]] of (0, 0, 0) and will be assigned an ID of "flame_01".

<WRAP center round tip 100%>
Use the **Add Effect** function to add weather or environmental effects to a scene, e.g. rain or snow to cover an outdoor [[map]], or flames to indicate that something has caught on fire.
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:add_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