Skip to main content

RenderSteppedCallbackInfo

Type

Describes a RenderStepped callback's information.

Properties​

Priority​

This item is read only and cannot be modified. Read Only
</>
RenderSteppedCallbackInfo.Priority: number

The execution priority of the callback (e.g., Enum.RenderPriority.Camera).

Name​

This item is read only and cannot be modified. Read Only
</>
RenderSteppedCallbackInfo.Name: string

The name given to the callback, often indicating its purpose.

Foreign​

This item is read only and cannot be modified. Read Only
</>
RenderSteppedCallbackInfo.Foreign: boolean

A boolean indicating if the callback originates from a different Luau Virtual Machine (e.g., an Actor thread).

Thread​

This item is read only and cannot be modified. Read Only
</>
RenderSteppedCallbackInfo.Thread: thread?

The Luau thread (coroutine) this callback belongs to. nil if Foreign is true unless Argument #1 bypassForeignCheck of getrendersteppedlist is true.

Function​

This item is read only and cannot be modified. Read Only
</>
RenderSteppedCallbackInfo.Function: (() → ())?

The Luau function associated with this callback. nil if Foreign is true unless Argument #1 bypassForeignCheck of getrendersteppedlist is true.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Priority",
            "desc": "The execution priority of the callback (e.g., `Enum.RenderPriority.Camera`).",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 15,
                "path": "impl/Types/RenderSteppedCallbackInfo.luau"
            }
        },
        {
            "name": "Name",
            "desc": "The name given to the callback, often indicating its purpose.",
            "lua_type": "string",
            "readonly": true,
            "source": {
                "line": 24,
                "path": "impl/Types/RenderSteppedCallbackInfo.luau"
            }
        },
        {
            "name": "Foreign",
            "desc": "A boolean indicating if the callback originates from a different Luau Virtual Machine (e.g., an Actor thread).",
            "lua_type": "boolean",
            "readonly": true,
            "source": {
                "line": 33,
                "path": "impl/Types/RenderSteppedCallbackInfo.luau"
            }
        },
        {
            "name": "Thread",
            "desc": "The Luau thread (coroutine) this callback belongs to. `nil` if `Foreign` is true unless Argument #1 `bypassForeignCheck` of `getrendersteppedlist` is true.",
            "lua_type": "thread?",
            "readonly": true,
            "source": {
                "line": 42,
                "path": "impl/Types/RenderSteppedCallbackInfo.luau"
            }
        },
        {
            "name": "Function",
            "desc": "The Luau function associated with this callback. `nil` if `Foreign` is true unless Argument #1 `bypassForeignCheck` of `getrendersteppedlist` is true.",
            "lua_type": "(() -> ())?",
            "readonly": true,
            "source": {
                "line": 51,
                "path": "impl/Types/RenderSteppedCallbackInfo.luau"
            }
        }
    ],
    "types": [],
    "name": "RenderSteppedCallbackInfo",
    "desc": "Describes a RenderStepped callback's information.",
    "tags": [
        "Type"
    ],
    "source": {
        "line": 6,
        "path": "impl/Types/RenderSteppedCallbackInfo.luau"
    }
}