User Tools

Site Tools


play_animation

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
play_animation [2018/03/16 09:46]
justin
play_animation [2020/07/23 11:56] (current)
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:​==== ====Signature:​====
Line 10: 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 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://​ Triggers 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 trigger animations for doors being opened and closed upon player interaction or for special NPC emotes (e.g. waving at the player).+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 32: 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.1521218796.txt.gz · Last modified: 2018/03/16 09:46 by justin