filtergc

filtergc allows you to retrieve specific garbage-collected values from Luau's memory, using fine-tuned filters.

This function is most often used to find game-defined functions or internal tables by matching constants, keys, metatables, and more. It behaves similarly to getgc, but offers simplicity, efficiency, and more control over what gets returned.

export type AnyFunction = (...any) -> (...any)
export type AnyTable = { [any]: any }

declare filtergc: 
    (( filterType: "function", filterOptions: FunctionFilterOptions, returnOne: true) -> AnyFunction? ) &
    ((( filterType: "function", filterOptions: FunctionFilterOptions, returnOne: false?) -> ( AnyFunction | { AnyFunction } ) )) &
    (( filterType: "table", filterOptions: TableFilterOptions, returnOne: true) -> { AnyTable? } ) &
    (( filterType: "table", filterOptions: TableFilterOptions, returnOne: false? ) -> { AnyTable })

---

Parameters

Parameter	Description
filterType	The type of value to search for.
filterOptions	A set of rules used to match functions or tables. See below.
returnOne?	If true, returns the first match, instead of a table of matches.

---

Filter option types

Each filter type has its own valid fields:

• See Function Filters for matching functions by name, constants, upvalues, and more.
• See Table Filters for matching tables by keys, values, metatables, and more.

---

Notes

• Garbage-collected values must still be referenced by a live thread to be found.
• Some filters (like Constants or Hash) do not apply to C functions.