Skip to main content

object_utils

std

this module provides utilities for creating kit objects.

Functions​

register​

</>
object_utils.register(
object: object--

the object to register.

) → processed_object--

the registered object.

register an object with the kit, preparing it for further use.

Show raw api
{
    "functions": [
        {
            "name": "register",
            "desc": "register an object with the kit, preparing it for further use.",
            "params": [
                {
                    "name": "object",
                    "desc": "the object to register.",
                    "lua_type": "object"
                }
            ],
            "returns": [
                {
                    "desc": "the registered object.",
                    "lua_type": "processed_object"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/shared/kit/std/object.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "object_utils",
    "desc": "this module provides utilities for *creating kit objects*.",
    "tags": [
        "std"
    ],
    "source": {
        "line": 12,
        "path": "src/shared/kit/std/object.luau"
    }
}