climate/terminal-objects/animation.md

---

layout: default title: Animation

permalink: /terminal-objects/animation/

Animation

Wait, what? Why does this exist? Because fun, that's why.

Basically animate will take ASCII art and run basic animations on it in the terminal.

Just like Draw, you can add custom ASCII art using the addArt method.

Valid directions are 'top', 'bottom', 'left', 'right'.

Enter From, Exit To

$climate->animation('hello')->enterFrom('right');
$climate->animation('hello')->enterFrom('left');
$climate->animation('hello')->enterFrom('top');
$climate->animation('hello')->enterFrom('bottom');

$climate->animation('hello')->exitTo('right');
$climate->animation('hello')->exitTo('left');
$climate->animation('hello')->exitTo('top');
$climate->animation('hello')->exitTo('bottom');

Scroll

$climate->animation('hello')->scroll('right');
$climate->animation('hello')->scroll('left');
$climate->animation('hello')->scroll('top');
$climate->animation('hello')->scroll('bottom');

Speed

You can alter the speed of the animation with the speed method. The paramter should be an integer representing the percentage of the default speed.

For example, 50 would make it slower by half, whereas 200 would make it run at twice the speed.

// This will animate twice as fast
$climate->animation('hello')->speed(200)->scroll('right');

Custom Animations

Let's say you have some time on your hands. You can create a directory of text files that represent each keyframe in an animation and just run it manually:

$climate->addArt(__DIR__ . '/custom-animation');
$climate->animation('custom-animation')->run();