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 entitylist

Categories

Parameters

  • [type] (optional)

Info

Returns a list (Lua table) containing the positions (as X and Y tile coordinates) of all entities (except for Env_Decal). You can also limit the output to a certain entity type by using the optional type parameter.

Use a "for"-loop and "in pairs" of Lua to process the resulting list properly!

Sample 1: Iterating over list using in pairs
local list=entitylist()
for _,e in pairs(list) do
   print("entity @ ("..e.x..","..e.y..") - "..entity(e.x,e.y,"typename"))
end

Note: The resulting "list" is actually a Lua table with one sub Lua table per entity in it. The sub tables have the fields/indices "x" and "y" which contain the X and Y tile coordinates of an entity.
Attention: Env_Decal entities are NOT included in this list!
Attention: This command worked a bit differently in version b 0.1.2.0 (in which it was introduced). It didn't work properly so a change of the returned table was necessary. Please change your scripts if you used this command in b 0.1.2.0!