getgc

getgc(includeTables: boolean?) -> { function | table | userdata | thread }

​

Parameters

​

Returns

​

Behavior

• Only live objects are included. Objects already marked dead by the collector are skipped.
• The result is scoped to the Lua state you call from. Objects belonging to other Actor VMs are not visible here. Use the actors library to reach those states.
• Proto objects and other internal-only collectables are never returned; the set is limited to functions and, with includeTables, tables, userdata, and threads.

​

Example

local counts = {}
for _, object in getgc(true) do
    local kind = typeof(object)
    counts[kind] = (counts[kind] or 0) + 1
end

for kind, total in counts do
    print(kind, total)
end

​

Errors

​

Related

• filtergc: targeted search without building the full set.
• getallthreads: just the threads, directly.