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.

======Play Animation======
----

Plays an [[animation]] for the specified [[entity]]. [[entity|Entities]] include [[tile|tiles]], [[object|objects]], and [[character|characters]].

====Signature:====
<code python>
play_animation(entity, animation_name)
</code>

^Argument^Description^Type^Required^
|entity|[[Entity]] for which to play the [[animation]].|[[Entity]]|Yes|
|animation_name|Name of the [[animation]] to play (as defined in the [[Voxel Editor]]).|[[String]]|Yes|

<WRAP center round info 100%>
You can use [[Play Group Animation]] if you'd like to trigger the same [[animation]] for multiple [[entity|entities]] that have been grouped together from the [[Map Editor]].
</WRAP>

====Example:====
<code bauxite>
play_animation(entity["chest01"], "open");
</code>
//Results:// Triggers the [[animation]] named "open" for the [[entity]] with an ID of "chest01".

<WRAP center round tip 100%>
Use the **Play Animation** function to trigger [[animation|animations]] for doors being opened and closed upon player interaction or for special [[NPC]] emotes (e.g. waving at the player).
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:play_animation_node.png?nolink|}}
</WRAP>

<WRAP half column>
====Visual Demo:====
{{:play_animation_demo.gif?nolink|}}
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation