play_animation
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revisionNext revisionBoth sides next revision | ||
| play_animation [2017/04/24 15:58] – external edit 127.0.0.1 | play_animation [2018/03/16 09:46] – justin | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ---- | ---- | ||
| - | Plays an animation for the specified entity. | + | Plays an animation for the specified entity. Entities include tiles, objects, and characters. |
| + | ====Signature: | ||
| <code python> | <code python> | ||
| - | play_animation(self, " | + | play_animation(entity, animation_name) |
| </ | </ | ||
| ^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
| - | |self|Description.|[[String]]|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| |
| + | |||
| + | <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. | ||
| + | </ | ||
| ====Example: | ====Example: | ||
| <code python> | <code python> | ||
| - | play_animation(self, "anim_name") | + | play_animation(entity[" |
| </ | </ | ||
| - | // | + | // |
| <WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
| - | Use the **Play Animation** function to ... | + | 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). |
| </ | </ | ||
play_animation.txt · Last modified: 2021/04/21 18:37 by justin
Page Tools
