Commands/Lua

Reference for console commands, Lua hooks and Lua commands in CS2D.

Console Commands are entered in console, executed with key-binds, cfg-files or with Lua parse
Lua Hooks execute Lua when events occur - some have a return value which can change the game behavior
Lua Commands are used to retrieve game data or to perform actions in Lua scripts

CS2D Console Commands

Lua Hooks

Lua Commands

tween_animate

Parameters

speed

mode

Info

Creates an animation tween which changes the frame of the spritesheet image with the specified id constantly.
The speed defines how many milliseconds each frame should be displayed.

You can also specify an animation mode:

0 - Loop Forward (play from current frame to last frame and then continue at first frame)

1 - Loop Backward (play from current frame to first frame and then continue at last frame)

2 - Ping Pong Forward (play forward to last frame and then backward to first frame etc.)

3 - Ping Pong Backward (play backward to first frame and then forward to last frame etc.)

4 - Random (an entirely random frame is displayed every speed milliseconds)

The tween stays active until another tween_animate or tween_frame is applied to the same image.

Note: The used image must be a loaded as spritesheet image with the image-command so it has multiple frames!

Note: Speed in ms (milliseconds, 1000 ms = 1 sec)