Volt Documentation

Filters objects in the garbage collector based on specified criteria.

Syntax

filtergc(type: string, options: table) -> table

Parameters

Parameter	Type	Description
`type`	`string`	The type of object to find ("function" or "table")
`options`	`table`	Filter options

Returns

Type	Description
`table`	Array of matching objects

Description

filtergc efficiently searches through garbage-collected objects with specific filter criteria. This is more performant than manually iterating through getgc().

Option	Type	Description
`Name`	`string`	Match function name
`Constants`	`table`	Match constants in function
`Upvalues`	`table`	Match upvalue values
`IgnoreExecutor`	`boolean`	Exclude volt functions

Option	Type	Description
`Keys`	`table`	Match table keys
`Values`	`table`	Match table values
`KeyValuePairs`	`table`	Match key-value pairs
`Metatable`	`table`	Match metatable

Example: Find Function by Name

local functions = filtergc("function", {
    Name = "targetFunction"
})

for _, func in ipairs(functions) do
    print("Found:", func)
end

Example: Find Function by Constants

local functions = filtergc("function", {
    Constants = {"SomeUniqueString", "AnotherString"}
})

Example: Find Table by Keys

local tables = filtergc("table", {
    Keys = {"Health", "MaxHealth", "Damage"}
})

for _, tbl in ipairs(tables) do
    print("Found table with game stats")
end

Example: Ignore Volt Functions

local gameFunctions = filtergc("function", {
    Name = "Update",
    IgnoreExecutor = true
})

getgc - Get all GC objects

filtergc

On this page