User Tools

Site Tools


add_effect

This is an old revision of the document!


Add Effect


(WIP)

Adds a character to the specified tile within the map (if the tile is not already occupied by another character). The entity ID is optional and will be assigned to the new character if supplied.

Signature:

add_character(effect_name, coordinate, entity_id)
ArgumentDescriptionTypeRequired
effect_nameParticle effect to use for the new effect.StringYes
coordinateID or coordinate of the tile where the character will be placed.String, CoordinateYes
entity_idUnique entity ID that will be assigned.StringNo

The Remove Entity function can be triggered later to remove a character that was previously added to the scene with the Add Character function.

Return ValueDescriptionType
Character AddedReturns a reference to the character that was added.Entity

Example:

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

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

Use the Add Effect function to…


Editor Node:

Visual Demo:

add_effect.1706390087.txt.gz · Last modified: 2024/01/27 13:14 by justin