Skip to main content

types

kit

this module contains types used by kit scripts.

Types​

pillar​

</>
interface pillar {
id: string--

the id of the pillar.

name: string--

the name of the pillar.

difficulty: string--

the difficulty of the pillar.

creator: string--

the creator of the pillar.

}

represents a pillar that the player can play.

object​

</>
interface object {
events: {
load: (
self: object<T>,
pillar: pillar
) → ()?,
unload: (
self: object<T>,
pillar: pillar
) → ()?
}--

the lifecycle events of the object.

attributes: {[string]: {[string]: any}}--

the attributes of the object.

}

represents a pillar (or everpresent) object.

TIP

this is for objects that haven't been passed through object_utils.register!

processed_object​

</>
interface processed_object {
id: string--

the id of the object.

attributes: {[string]: {[string]: any}}--

the attributes of the object.

instance: BasePart--

the instance of the object.

events: {
load: (
self: object<T>,
pillar: pillar
) → ()?,
unload: (
self: object<T>,
pillar: pillar
) → ()?
}--

the lifecycle events of the object.

group: item_group--

the group of the object.

}

represents a pillar (or everpresent) object.

TIP

this is for objects that have been passed through object_utils.register!

pillar_data​

</>
interface pillar_data {
id: string--

the id of the pillar.

group: item_group--

the group of the pillar.

}

represents a pillar that the player can play.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "pillar",
            "desc": "represents a pillar that the player can play.",
            "fields": [
                {
                    "name": "id",
                    "lua_type": "string",
                    "desc": "the id of the pillar."
                },
                {
                    "name": "name",
                    "lua_type": "string",
                    "desc": "the name of the pillar."
                },
                {
                    "name": "difficulty",
                    "lua_type": "string",
                    "desc": "the difficulty of the pillar."
                },
                {
                    "name": "creator",
                    "lua_type": "string",
                    "desc": "the creator of the pillar."
                }
            ],
            "source": {
                "line": 25,
                "path": "src/shared/kit/types.luau"
            }
        },
        {
            "name": "object",
            "desc": "represents a pillar (or everpresent) object.\n\n:::tip\nthis is for objects that haven't been passed through `object_utils.register`!\n:::",
            "fields": [
                {
                    "name": "events",
                    "lua_type": "{ load: (self: object<T>, pillar: pillar) -> ()?, unload: (self: object<T>, pillar: pillar) -> ()? }",
                    "desc": "the lifecycle events of the object."
                },
                {
                    "name": "attributes",
                    "lua_type": "{ [string]: { [string]: any } }",
                    "desc": "the attributes of the object."
                }
            ],
            "source": {
                "line": 46,
                "path": "src/shared/kit/types.luau"
            }
        },
        {
            "name": "processed_object",
            "desc": "represents a pillar (or everpresent) object.\n\n:::tip\nthis is for objects that have been passed through `object_utils.register`!\n:::",
            "fields": [
                {
                    "name": "id",
                    "lua_type": "string",
                    "desc": "the id of the object."
                },
                {
                    "name": "attributes",
                    "lua_type": "{ [string]: { [string]: any} }",
                    "desc": "the attributes of the object."
                },
                {
                    "name": "instance",
                    "lua_type": "BasePart",
                    "desc": "the instance of the object."
                },
                {
                    "name": "events",
                    "lua_type": "{ load: (self: object<T>, pillar: pillar) -> ()?, unload: (self: object<T>, pillar: pillar) -> ()? }",
                    "desc": "the lifecycle events of the object."
                },
                {
                    "name": "group",
                    "lua_type": "item_group",
                    "desc": "the group of the object."
                }
            ],
            "source": {
                "line": 72,
                "path": "src/shared/kit/types.luau"
            }
        },
        {
            "name": "pillar_data",
            "desc": "represents a pillar that the player can play.",
            "fields": [
                {
                    "name": "id",
                    "lua_type": "string",
                    "desc": "the id of the pillar."
                },
                {
                    "name": "group",
                    "lua_type": "item_group",
                    "desc": "the group of the pillar."
                }
            ],
            "source": {
                "line": 95,
                "path": "src/shared/kit/types.luau"
            }
        }
    ],
    "name": "types",
    "desc": "this module contains types *used by kit scripts*.",
    "tags": [
        "kit"
    ],
    "source": {
        "line": 12,
        "path": "src/shared/kit/types.luau"
    }
}