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

• ALL
• Script
• Controls
• Settings
• Server
• Bots
• Debug
• Security

Lua Hooks

• ALL
• Basic
• Time
• Player
• Object

Lua Commands

• ALL
• Basic
• Timer
• Image
• Game
• Map
• Tile
• Player
• Item
• Entity
• Object
• Projectile
• AI

playerammo

Categories

Player, Item

Parameters

• id

• itemtype

Info

Returns how much ammo the specified player has left in the specified weapon.

Returns two values:

• The ammo currently loaded into the weapon


• the spare ammo for reloading

If the player does not exist or the player does not carry the weapon of the specified type, CS2D will return a boolean false (single value).

Item type IDs:


Example:

addhook("say","getammo")
function getammo(pID, chatMsg)
   if chatMsg == "ammo" then
      local weaponType = player(pID, "weapontype")
      local ammoIn,ammo = playerammo(pID, weaponType)
      msg(player(pID, "name") .. " ammo: " .. ammoIn .. "|" .. ammo)
   end
end

Attention: The ammo values the server has for other network players are just an approximation! Players might actually have LESS ammo than returned by this command - but never more (this can be caused by bad network conditions like lag and package loss). The values are only guaranteed to be accurate for the own player (when hosting a game locally) and for bots.