This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
add_effect [2024/01/27 13:14] – created justin | add_effect [2024/01/27 14:21] – justin | ||
---|---|---|---|
Line 1: | Line 1: | ||
======Add Effect====== | ======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. | |
- | Adds a [[character|character]] to the specified [[tile|tile]] within the [[map|map]] (if the [[tile|tile]] is not already occupied by another [[character|character]]). The [[entity|entity]] ID is optional and will be assigned to the new [[character|character]] if supplied. | + | |
====Signature: | ====Signature: | ||
<code python> | <code python> | ||
- | add_character(effect_name, | + | add_effect(effect_name, |
</ | </ | ||
^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
|effect_name|Particle effect to use for the new [[effect]].|[[string|String]]|Yes| | |effect_name|Particle effect to use for the new [[effect]].|[[string|String]]|Yes| | ||
- | |coordinate|ID or [[coordinate|coordinate]] of the [[tile|tile]] where the [[character|character]] will be placed.|[[string|String]], | + | |coordinate|[[Coordinate]] where the [[effect]] will be placed.|[[coordinate|Coordinate]]|Yes| |
|entity_id|Unique [[entity|entity]] ID that will be assigned.|[[string|String]]|No| | |entity_id|Unique [[entity|entity]] ID that will be assigned.|[[string|String]]|No| | ||
<WRAP center round info 100%> | <WRAP center round info 100%> | ||
- | The [[remove_entity|Remove Entity]] function can be triggered later to remove | + | The [[remove_entity|Remove Entity]] function can be triggered later to remove |
</ | </ | ||
^Return Value^Description^Type^ | ^Return Value^Description^Type^ | ||
- | |Character | + | |Effect |
====Example: | ====Example: | ||
Line 25: | Line 24: | ||
add_effect(" | add_effect(" | ||
</ | </ | ||
- | // | + | // |
<WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
- | Use the **Add Effect** function to... | + | 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. |
</ | </ | ||
Line 40: | Line 39: | ||
<WRAP half column> | <WRAP half column> | ||
- | ====Visual Demo:==== | ||
- | {{: | ||
</ | </ | ||
</ | </ | ||
~~NOTOC~~ | ~~NOTOC~~ |