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

Category: all (85)

Lua Command item

Categories

Parameters

  • id
  • "value"

Info

Returns a value of an item instance on the map:

  • exists: boolean, true if an item with that ID exists, false otherwise
  • name: name of that item
  • type: internal item type ID
  • player: ID of player that carries this item or 0 if it is dropped
  • ammo: ammo supply for that weapon (not loaded in it)
  • ammoin: ammo currently loaded into the weapon
  • mode: weapon mode (e.g. color of laser, silenced or not)
  • x: X position of dropped weapon on map (in tiles)
  • y: Y position of dropped weapon on map (in tiles)
  • dropped: boolean, true if weapon has been dropped by a player, false otherwise (false implies that the item as been spawned via item/script)
  • droptimer: how long is it ago that the weapon has been dropped (in seconds)


Moreover there is:
item(0,"table"): returns a Lua table with all IDs of items which are on the map (the unique instance IDs, NOT the type IDs!)

Item names and type IDs:
items

Sample 1: Using the item table to list the names of all items
local itemlist=item(0,"table")
for _,id in pairs(itemlist) do
   print(item(id,"name"))
end

Attention: Items carried by players cannot be accessed with this command. Use playerweapons to get a list of item types a player currently carries.