Commands/Lua

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

CS2D Command CS2D Console Commands

Lua Hook Lua Hooks

Lua Command Lua Commands

Lua Command playerammo

Categories

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:
items

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.