Skip to main content

GcState

Type

Contains the state of the Luau Garbage Collector at one point in time.

Properties​

GCThreshold​

This item is read only and cannot be modified. Read Only
</>
GcState.GCThreshold: userdata<std::size_t>
Representation in Luau

This is a std::size_t, which is a 64-bit integer. Lua(u) cannot represent this type effectively. In order to counteract this, a string is returned when indexed by Lua(u).

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "GCThreshold",
            "desc": ":::warning Representation in Luau\nThis is a `std::size_t`, which is a 64-bit integer. Lua(u) cannot represent this type effectively. In order to counteract this, a `string` is returned when indexed by Lua(u).\n:::",
            "lua_type": "userdata<std::size_t>",
            "readonly": true,
            "source": {
                "line": 16,
                "path": "impl/Types/GcState.luau"
            }
        }
    ],
    "types": [],
    "name": "GcState",
    "desc": "Contains the state of the Luau Garbage Collector at one point in time.",
    "tags": [
        "Type"
    ],
    "source": {
        "line": 6,
        "path": "impl/Types/GcState.luau"
    }
}