Skip to main content

RobloxApiClass

Represents a specific Roblox class.

Functions​

new​

</>
RobloxApiClass.new(
robloxApiDump: RobloxApiDump,
data: table
) → RobloxApiClass

Constructs a new RobloxApiClass. See RobloxApiDump.PromiseClass to actually construct this class.

GetRawData​

</>
RobloxApiClass.GetRawData(self: RobloxApiClass) → table

Retrieves the raw class data

GetClassName​

</>
RobloxApiClass.GetClassName(self: RobloxApiClass) → string

Gets the class name.

GetMemberCategory​

</>
RobloxApiClass.GetMemberCategory(self: RobloxApiClass) → string?

Gets the class category.

PromiseSuperClass​

</>
RobloxApiClass.PromiseSuperClass(self: RobloxApiClass) → Promise<RobloxApiClass>

Retrieves the super class, or rejects.

PromiseIsA​

</>
RobloxApiClass.PromiseIsA(
className: string
) → Promise<boolean>

Returns a promise that resolves whether this class is of a specific type.

PromiseIsDescendantOf​

</>
RobloxApiClass.PromiseIsDescendantOf(
className: string
) → Promise<boolean>

Returns a promise that resolves whether this class is a descendant of another specific class.

PromiseAllSuperClasses​

</>
RobloxApiClass.PromiseAllSuperClasses(self: RobloxApiClass) → Promise<{RobloxApiClass}>

Returns a promise that resolves to all super classes.

GetSuperClassName​

</>
RobloxApiClass.GetSuperClassName(self: RobloxApiClass) → string?

Returns the super class name

HasSuperClass​

</>
RobloxApiClass.HasSuperClass(self: RobloxApiClass) → boolean

Returns whether the class has a super class

PromiseMembers​

</>
RobloxApiClass.PromiseMembers(self: RobloxApiClass) → Promise<{RobloxApiMember}>

Retrieves all class members (events, properties, callbacks, functions).

PromiseMember​

</>
RobloxApiClass.PromiseMember(
memberName: string
) → Promise.Promise<RobloxApiMember.RobloxApiMember?>

Returns a specific member by name, or nil if it doesn't exist.

PromiseProperty​

</>
RobloxApiClass.PromiseProperty(
propertyName: string
) → Promise.Promise<RobloxApiMember.RobloxApiMember?>

Returns a specific property by name, or nil if it doesn't exist.

PromiseProperties​

</>
RobloxApiClass.PromiseProperties(self: RobloxApiClass) → Promise<{RobloxApiMember}>

Gets all class properties.

PromiseEvents​

</>
RobloxApiClass.PromiseEvents(self: RobloxApiClass) → Promise<{RobloxApiMember}>

Gets all class events.

PromiseFunctions​

</>
RobloxApiClass.PromiseFunctions(self: RobloxApiClass) → Promise<{RobloxApiMember}>

Gets all class functions (i.e. methods).

IsService​

</>
RobloxApiClass.IsService(self: RobloxApiClass) → boolean

Retrieves whether the class is a service

IsNotCreatable​

</>
RobloxApiClass.IsNotCreatable(self: RobloxApiClass) → boolean

Retrieves whether the class is not creatable

IsNotReplicated​

</>
RobloxApiClass.IsNotReplicated(self: RobloxApiClass) → boolean

Retrieves whether the class is not replicated

HasTag​

</>
RobloxApiClass.HasTag(
tagName: string
) → boolean

Retrieves whether the class has a tag or not

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new RobloxApiClass. See [RobloxApiDump.PromiseClass] to actually construct\nthis class.",
            "params": [
                {
                    "name": "robloxApiDump",
                    "desc": "",
                    "lua_type": "RobloxApiDump"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 40,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "GetRawData",
            "desc": "Retrieves the raw class data",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 68,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "GetClassName",
            "desc": "Gets the class name.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 76,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "GetMemberCategory",
            "desc": "Gets the class category.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 85,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseSuperClass",
            "desc": "Retrieves the super class, or rejects.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<RobloxApiClass>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 93,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseIsA",
            "desc": "Returns a promise that resolves whether this class is of a specific type.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                },
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseIsDescendantOf",
            "desc": "Returns a promise that resolves whether this class is a descendant of another\nspecific class.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                },
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 122,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseAllSuperClasses",
            "desc": "Returns a promise that resolves to all super classes.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<{ RobloxApiClass }>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 138,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "GetSuperClassName",
            "desc": "Returns the super class name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 174,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "HasSuperClass",
            "desc": "Returns whether the class has a super class",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 187,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseMembers",
            "desc": "Retrieves all class members (events, properties, callbacks, functions).",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<{ RobloxApiMember }>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 195,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseMember",
            "desc": "Returns a specific member by name, or nil if it doesn't exist.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                },
                {
                    "name": "memberName",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<RobloxApiMember.RobloxApiMember?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 221,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseProperty",
            "desc": "Returns a specific property by name, or nil if it doesn't exist.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                },
                {
                    "name": "propertyName",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<RobloxApiMember.RobloxApiMember?>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 233,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseProperties",
            "desc": "Gets all class properties.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<{ RobloxApiMember }>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 250,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseEvents",
            "desc": "Gets all class events.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<{ RobloxApiMember }>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 266,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "PromiseFunctions",
            "desc": "Gets all class functions (i.e. methods).",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<{ RobloxApiMember }>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 282,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "IsService",
            "desc": "Retrieves whether the class is a service",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 298,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "IsNotCreatable",
            "desc": "Retrieves whether the class is not creatable",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 306,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "IsNotReplicated",
            "desc": "Retrieves whether the class is not replicated",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 314,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        },
        {
            "name": "HasTag",
            "desc": "Retrieves whether the class has a tag or not",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                },
                {
                    "name": "tagName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 323,
                "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RobloxApiClass",
    "desc": "Represents a specific Roblox class.",
    "source": {
        "line": 6,
        "path": "src/roblox-api-dump/src/Shared/Dump/RobloxApiClass.lua"
    }
}