This is an old revision of the document!

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.

add_character(effect_name, coordinate, entity_id)

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

The Remove Entity function can be triggered later to remove an effect that was previously added to the scene with the Add Effect function.

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

add_effect("flame", coord[0, 0, 0], "flame_01");

Results: A flame effect will be added to the map at the XYZ coordinate of (0, 0, 0) and will be assigned an ID of “flame_01”.

Use the Add Effect function to…

RPG in a Box
Official Documentation