Skip to main content

EnumeratorObject

Types#

EnumeratorItem#

Enum
</>
interface EnumeratorItem {
name: string--

The name of the EnumeratorItem.

type: EnumeratorObject<Value>--

Returns the EnumeratorObject that this EnumeratorItem belongs to.

value: Value--

The value of the EnumeratorItem.

rawName: () → string--

A function version of .name.

rawType: () → EnumeratorObject<Value>--

A function version of .type.

rawValue: () → Value--

A function version of .value.

}

An EnumeratorItem is meant to represent a unique value.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "EnumeratorItem",
            "desc": "An EnumeratorItem is meant to represent a unique value.",
            "fields": [
                {
                    "name": "name",
                    "lua_type": "string",
                    "desc": "The name of the EnumeratorItem."
                },
                {
                    "name": "type",
                    "lua_type": "EnumeratorObject<Value>",
                    "desc": "Returns the EnumeratorObject that this EnumeratorItem belongs to."
                },
                {
                    "name": "value",
                    "lua_type": "Value",
                    "desc": "The value of the EnumeratorItem."
                },
                {
                    "name": "rawName",
                    "lua_type": "() -> string",
                    "desc": "A function version of `.name`."
                },
                {
                    "name": "rawType",
                    "lua_type": "() -> EnumeratorObject<Value>",
                    "desc": "A function version of `.type`."
                },
                {
                    "name": "rawValue",
                    "lua_type": "() -> Value",
                    "desc": "A function version of `.value`."
                }
            ],
            "tags": [
                "Enum"
            ],
            "source": {
                "line": 79,
                "path": "src/init.lua"
            }
        }
    ],
    "name": "EnumeratorObject",
    "desc": "",
    "source": {
        "line": 95,
        "path": "src/init.lua"
    }
}