getgc

Returns an array table of live Luau garbage-collected objects visible to the API. Functions and userdata-like objects are included by default. Tables are included only when includeTables is true. get_gc_objects is an alias.

Syntax

getgc(includeTables?: boolean): table

Aliases

get_gc_objects

Arguments

Name	Type	Required	Description
`includeTables`	`boolean`	No	Optional boolean. When true, live tables are included in addition to functions and userdata-like objects.

Returns

Name	Type	Description
`objects`	`table`	Array table containing matching live objects, plus live tables when includeTables is true.

Example

Read the current GC object list, optionally including tables.

local objects = getgc()
print(type(objects))

local withTables = getgc(true)
print(type(withTables))

local aliasResult = get_gc_objects()
print(type(aliasResult))

⌘I

Overview

Cache

Cryptography

Filesystem

JSON

Console

Drawing

ImGui

Input

Instances

Reflection

Scripts

Signals

WebSocket

Actors

Closures

Debug

Environment

Metatables

Threads

Disassembler

Miscellaneous

RakNet

RealSignal

SaveInstance

Syntax

Aliases

Arguments

Returns

Example

​Syntax

​Aliases

​Arguments

​Returns

​Example

Syntax

Aliases

Arguments

Returns

Example