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
customkillCategories
Parameters
- killer (0-32): killer player id (or 0 for no killer)
- weapon (text): a name for the weapon the killer used (as text!) + optionally a path to an image
- victim (1-32): victim player id
Info
Simulate a kill with a custom weapon (as server only). This will also generate an appropriate death notice in the top right corner of the screen and give the killer an additional kill in the scoreboard.
Use killer 0 for suicides or "environment kills".
You can also specify a custom kill image in addition to the weapon name. Both are in the weapon parameter and they have to be separated with a comma. This image will only be displayed if the setting deathnoticeimg is set to 1! Otherwise the game will just display the text.
So the format for weapon can either be
"weapon name"
or
"weapon name,image path"
Note that you have to use quotes as soon as there are any spaces in the weapon name or in the weapon path! You don't have to use quotes around this parameter if there are no spaces.
Note: Nothing will happen if the victim is already dead!
Note: The path for custom kill images is relative to the CS2D main folder
Note: Custom kill images should be grayscale because they are rendered with blending. White parts will become bright and dark parts will become invisible.
Attention: Custom kill images should have a height of about 10 pixels. Higher images might overlap other death notices!
Attention: CS2D will NOT transfer the kill image to clients automatically! You have to put it into "sys/servertransfer.lst" like all custom images you are using in scripts. Otherwise clients won't see them! Also clients can still refuse to load them (depends on their settings)
Sample 1: Player 1 kills player 2 with a custom weapon (name only)
customkill 1 "Random Weapon Name" 2
Sample 2: Player 1 kills player 2 with a custom weapon and a custom kill image
customkill 1 "Random Weapon Name,gfx/gui_server.bmp" 2
Sample 3: Player 3 is killed by the environment (because killer is 0)
customkill 0 "Trap" 3
Lua Hooks
Lua Commands
Categories
Parameters
- killer (0-32): killer player id (or 0 for no killer)
- weapon (text): a name for the weapon the killer used (as text!) + optionally a path to an image
- victim (1-32): victim player id
Info
Simulate a kill with a custom weapon (as server only). This will also generate an appropriate death notice in the top right corner of the screen and give the killer an additional kill in the scoreboard.
Use killer 0 for suicides or "environment kills".
You can also specify a custom kill image in addition to the weapon name. Both are in the weapon parameter and they have to be separated with a comma. This image will only be displayed if the setting deathnoticeimg is set to 1! Otherwise the game will just display the text.
So the format for weapon can either be
"weapon name"
or
"weapon name,image path"
Note that you have to use quotes as soon as there are any spaces in the weapon name or in the weapon path! You don't have to use quotes around this parameter if there are no spaces.
Sample 1: Player 1 kills player 2 with a custom weapon (name only)
Sample 2: Player 1 kills player 2 with a custom weapon and a custom kill image
Sample 3: Player 3 is killed by the environment (because killer is 0)
Use killer 0 for suicides or "environment kills".
You can also specify a custom kill image in addition to the weapon name. Both are in the weapon parameter and they have to be separated with a comma. This image will only be displayed if the setting deathnoticeimg is set to 1! Otherwise the game will just display the text.
So the format for weapon can either be
"weapon name"
or
"weapon name,image path"
Note that you have to use quotes as soon as there are any spaces in the weapon name or in the weapon path! You don't have to use quotes around this parameter if there are no spaces.
Note: Nothing will happen if the victim is already dead!
Note: The path for custom kill images is relative to the CS2D main folder
Note: Custom kill images should be grayscale because they are rendered with blending. White parts will become bright and dark parts will become invisible.
Attention: Custom kill images should have a height of about 10 pixels. Higher images might overlap other death notices!
Attention: CS2D will NOT transfer the kill image to clients automatically! You have to put it into "sys/servertransfer.lst" like all custom images you are using in scripts. Otherwise clients won't see them! Also clients can still refuse to load them (depends on their settings)
Sample 1: Player 1 kills player 2 with a custom weapon (name only)
customkill 1 "Random Weapon Name" 2
Sample 2: Player 1 kills player 2 with a custom weapon and a custom kill image
customkill 1 "Random Weapon Name,gfx/gui_server.bmp" 2
Sample 3: Player 3 is killed by the environment (because killer is 0)
customkill 0 "Trap" 3
Lua Hooks Lua Commands