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

connect

Parameters

id: player id

Info

When a player connects to the game server. This hook is only invoked in a later step of the connection process. Players which cancel the connection process early or which are instantly disconnected (e.g. because of bans, wrong passwords, wrong client version or other reasons) won't trigger this hook.

Hook execution order when a player connects/joins:

Note: This hook is also executed for bots. Since bots do not have a real connection process, it will be INSTANTLY followed by the join hook.

Attention: This hook is not triggered if the connection process is cancelled in early stages for any reason.

Attention: The player is not fully connected at that point. You should not try to display Lua images, message or other things at this point. Use the join hook instead if you want to show stuff to the new player.

Return Values

none - related action(s) [if there are any] performed by CS2D cannot be altered/omitted