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
settileCategories
Parameters
- x (0-X): map x position (in tiles)
- y (0-X): map y position (in tiles)
- tile (0-255): tile frame index
Info
Changes the specified tile on the map to the given tile frame. This affects the tile look and the tile behavior. Works as server only. All other players will see the changes. Players who join afterwards will see the changes on their map too.
Changed tiles will not be changed back automatically unless another or the same map is reloaded!
You can use the Lua command tile with the parameters "hascustomframe" or "originalframe" to check if this command has been used with a certain tile.
Note: Changes made with settile do not affect the minimap.
Attention: The behaviors/properties of tiles are only saved up to the highest tile frame which is actually used on the map. Tiles with higher tile frames which are not used on the map but set with this command will always have the default behavior (soundless floor).
Attention: This command does not perform any advanced checks. You can set walls on players/NPCs/entities/items with this command. This may lead to bugs under certain circumstances. It is up to you to perform proper checks to avoid such problems!
Attention: Using this command to change a lot of tiles at once can lead to performance issues and even network connection loss. If you want to change many tiles do so in small batches with small delays.
Lua Hooks
Lua Commands
Categories
Parameters
- x (0-X): map x position (in tiles)
- y (0-X): map y position (in tiles)
- tile (0-255): tile frame index
Info
Changes the specified tile on the map to the given tile frame. This affects the tile look and the tile behavior. Works as server only. All other players will see the changes. Players who join afterwards will see the changes on their map too.
Changed tiles will not be changed back automatically unless another or the same map is reloaded!
You can use the Lua command tile with the parameters "hascustomframe" or "originalframe" to check if this command has been used with a certain tile.
Changed tiles will not be changed back automatically unless another or the same map is reloaded!
You can use the Lua command tile with the parameters "hascustomframe" or "originalframe" to check if this command has been used with a certain tile.
Note: Changes made with settile do not affect the minimap.
Attention: The behaviors/properties of tiles are only saved up to the highest tile frame which is actually used on the map. Tiles with higher tile frames which are not used on the map but set with this command will always have the default behavior (soundless floor).
Attention: This command does not perform any advanced checks. You can set walls on players/NPCs/entities/items with this command. This may lead to bugs under certain circumstances. It is up to you to perform proper checks to avoid such problems!
Attention: Using this command to change a lot of tiles at once can lead to performance issues and even network connection loss. If you want to change many tiles do so in small batches with small delays.
Lua Hooks Lua Commands