User Tools

Site Tools


predefined_animation_names

This is an old revision of the document!


Predefined Animation Names


In RPG in a Box, some animation names are connected to certain behaviors and scenarios. For example, when a character moves from one tile to another, the game will automatically trigger the “walk” animation for that character (if it exists).

When defining a new animation from the “Add Animation” dialog, you can click the button with the magnifying glass to easily pick from a list of supported names. Refer to the tables below (divided by entity type) for explanations of when each of these predefined animations gets triggered.

Characters

NameDescription
idlePlays whenever the character is standing still and no other animations are active. The animation type for this would typically be “Loop” or “Ping Pong”.
walkPlays whenever the character is moving from one tile to another. The animation type for this would typically be “Loop” or “Ping Pong”.
interactPlays whenever the character interacts with an object.
attackPlays whenever the character executes an attack during combat. The animation type for this would typically be “Once” or “Ping Pong Once”.
spawnPlays whenever the character is added to a map using the Add Character scripting function.
deathPlays whenever the character is killed/destroyed during combat or other hazardous situations.
climbPlays whenever the character is climbing a climbable tile. The first frame of the animation is displayed when initially grabbing onto the tile.

Tiles

NameDescription
defaultPlays as soon as the map is loaded. The animation type for this would typically be “Loop” or “Ping Pong” and is useful for liquid-based tiles like rivers and lava.
spawnPlays whenever the tile is added to a map using the Add Tile scripting function.

Objects

NameDescription
defaultPlays as soon as the map is loaded. The animation type for this would typically be “Loop” or “Ping Pong” and is useful for objects with continuous movement like campfires, windmills, etc.
spawnPlays whenever the object is added to a map using the Add Object scripting function.
movePlays whenever the object is configured as a vehicle and is being moved by the player.
attackPlays whenever the object is configured as a vehicle and the player attacks an enemy.
predefined_animation_names.1639262202.txt.gz · Last modified: 2021/12/11 14:36 by justin