Skip to main content

GetGcParameters

Type

Used to extend the parameters for memory.getgc from legacy versions of the API.

Properties​

Types​

</>
GetGcParameters.Types: {string}

The types that the returned table should include.

If not specified or not a table, defaults to returning all types.

UseWeakTable​

</>
GetGcParameters.UseWeakTable: boolean

Whether or not the returned table should be a weak table. This is recommended to be set to true.

If not specified, defaults to true.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Types",
            "desc": "The types that the returned table should include.\n\nIf not specified or not a table, defaults to returning all types.",
            "lua_type": "{ string }",
            "source": {
                "line": 17,
                "path": "impl/Types/GetGcParameters.luau"
            }
        },
        {
            "name": "UseWeakTable",
            "desc": "Whether or not the returned table should be a weak table. This is recommended to be set to true.\n\nIf not specified, defaults to true.",
            "lua_type": "boolean",
            "source": {
                "line": 27,
                "path": "impl/Types/GetGcParameters.luau"
            }
        }
    ],
    "types": [],
    "name": "GetGcParameters",
    "desc": "Used to extend the parameters for `memory.getgc` from legacy versions of the API.",
    "tags": [
        "Type"
    ],
    "source": {
        "line": 7,
        "path": "impl/Types/GetGcParameters.luau"
    }
}