filtergc - Byte Documentation

filtergc(kind: string, options: table? = {}, returnOne: boolean? = false): any

Aliases

None.

Arguments

string

required

The object category to match: exactly “function” or “table”.

table

default:"{}"

The function/table filter criteria. See Filter options under Related types.

boolean

default:"false"

When true, return the first matching object instead of an array.

Returns

any

An array of matches, or the first match/nil when returnOne is true. The predicate overload always returns an array.

kind is exactly function or table. returnOne returns one match or nil; otherwise an array. Function options default IgnoreExecutor to true and mutate the passed options table. Predicate failures are swallowed. See options below. Related types: Scripts types & behavior.

Example

local marker = {ByteDocsMarker = true}
local matches = filtergc("table", {Keys = {"ByteDocsMarker"}})
print(#matches, marker.ByteDocsMarker)

​Aliases

​Arguments

​Returns

​Example

Aliases

Arguments

Returns

Example