RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
play_animation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
play_animation [2017/04/24 16:26] – justinplay_animation [2020/07/23 11:56] – justin
Line 2: Line 2:
 ---- ----
  
-Plays an animation for the specified entity. Entities include tiles, objects, and characters.+Plays an [[animation]] for the specified [[entity]]. [[entity|Entities]] include [[tile|tiles]], [[object|objects]], and [[character|characters]].
  
 +====Signature:====
 <code python> <code python>
 play_animation(entity, animation_name) play_animation(entity, animation_name)
Line 9: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|entity|Entity for which to play the animation.|[[Entity]]|Yes| +|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|+|animation_name|Name of the [[animation]] to play (as defined in the [[Voxel Editor]]).|[[String]]|Yes|
  
 <WRAP center round info 100%> <WRAP center round info 100%>
-You can use [[Play Group Animation]] if you'd like to trigger the same animation for multiple entities that have been previously grouped together from the Map Editor.+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> </WRAP>
  
 ====Example:==== ====Example:====
-<code python>+<code bauxite>
 play_animation(entity["chest01"], "open") play_animation(entity["chest01"], "open")
 </code> </code>
-//Results:// Plays the animation named "open" for the entity with an ID of "chest01".+//Results:// Triggers the [[animation]] named "open" for the [[entity]] with an ID of "chest01".
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Play Animation** function to ...+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>
  
Line 31: Line 32:
 <WRAP half column> <WRAP half column>
 ====Editor Node:==== ====Editor Node:====
-{{:wiki:play_animation_node.png?nolink|}}+{{:play_animation_node.png?nolink|}}
 </WRAP> </WRAP>
  
 <WRAP half column> <WRAP half column>
 ====Visual Demo:==== ====Visual Demo:====
-{{:wiki:play_animation_demo.gif?nolink|}}+{{:play_animation_demo.gif?nolink|}}
 </WRAP> </WRAP>
 </WRAP> </WRAP>
play_animation.txt · Last modified: 2021/04/21 18:37 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki