Skip to main content

RobloxApiMember

Represents a specific member of a class. This could be a property or event, or method, or callback.

Functions​

new​

</>
RobloxApiMember.new(data: table) → RobloxApiMember

Constructs a new RobloxApiMember wrapping the data given. See RobloxApiDump.PromiseMembers to actually construct this class.

GetName​

</>
RobloxApiMember:GetName() → string

Gets the member name.

GetCategory​

</>
RobloxApiMember:GetCategory() → string?

Gets the member category.

IsReadOnly​

</>
RobloxApiMember:IsReadOnly() → boolean

Retrieves whether the API member is read only.

GetMemberType​

</>
RobloxApiMember:GetMemberType() → string

Retrieves the member type.

IsEvent​

</>
RobloxApiMember:IsEvent() → boolean

Returns whether the member is an event.

GetRawData​

</>
RobloxApiMember:GetRawData() → table

Retrieves the raw member data

IsWriteNotAccessibleSecurity​

</>
RobloxApiMember:IsWriteNotAccessibleSecurity() → boolean

Returns whether this member has write NotAccessibleSecurity

IsReadNotAccessibleSecurity​

</>
RobloxApiMember:IsReadNotAccessibleSecurity() → boolean

Returns whether this member has write NotAccessibleSecurity

IsWriteLocalUserSecurity​

</>
RobloxApiMember:IsWriteLocalUserSecurity() → boolean

Returns whether this member has write LocalUserSecurity

IsReadLocalUserSecurity​

</>
RobloxApiMember:IsReadLocalUserSecurity() → boolean

Returns whether this member has read LocalUserSecurity

CanSerializeSave​

</>
RobloxApiMember:CanSerializeSave() → boolean?

Returns whether this can serialize save

CanSerializeLoad​

</>
RobloxApiMember:CanSerializeLoad() → boolean?

Returns whether this can serialize save

GetWriteSecurity​

</>
RobloxApiMember:GetWriteSecurity() → string?

Returns the member's write security as a string

GetReadSecurity​

</>
RobloxApiMember:GetReadSecurity() → string?

Returns the member's read security as a string

IsProperty​

</>
RobloxApiMember:IsProperty() → boolean

Returns whether the member is a property.

IsFunction​

</>
RobloxApiMember:IsFunction() → boolean

Returns whether the member is a function (i.e. method).

IsCallback​

</>
RobloxApiMember:IsCallback() → boolean

Returns whether the member is a callback.

IsNotScriptable​

</>
RobloxApiMember:IsNotScriptable() → boolean

Returns whether a script can modify it.

IsNotReplicated​

</>
RobloxApiMember:IsNotReplicated() → boolean

Returns whether the member is not replicated.

IsDeprecated​

</>
RobloxApiMember:IsDeprecated() → ()

Returns whether the member is deprecated..

IsHidden​

</>
RobloxApiMember:IsHidden() → boolean

Returns whether this api member is hidden.

GetTags​

</>
RobloxApiMember:GetTags() → {string}

Returns a list of tags. Do not modify this list.

HasTag​

</>
RobloxApiMember:HasTag(tagName: string) → boolean

Retrieves whether the member has a tag or not.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new RobloxApiMember wrapping the data given. See [RobloxApiDump.PromiseMembers] to actually\nconstruct this class.",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RobloxApiMember"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 16,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "GetName",
            "desc": "Gets the member name.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 61,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "GetCategory",
            "desc": "Gets the member category.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 70,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsReadOnly",
            "desc": "Retrieves whether the API member is read only.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 78,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "GetMemberType",
            "desc": "Retrieves the member type.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 86,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsEvent",
            "desc": "Returns whether the member is an event.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 95,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "GetRawData",
            "desc": "Retrieves the raw member data",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 103,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsWriteNotAccessibleSecurity",
            "desc": "Returns whether this member has write NotAccessibleSecurity",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 111,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsReadNotAccessibleSecurity",
            "desc": "Returns whether this member has write NotAccessibleSecurity",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 119,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsWriteLocalUserSecurity",
            "desc": "Returns whether this member has write LocalUserSecurity",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 127,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsReadLocalUserSecurity",
            "desc": "Returns whether this member has read LocalUserSecurity",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 135,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "CanSerializeSave",
            "desc": "Returns whether this can serialize save",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 143,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "CanSerializeLoad",
            "desc": "Returns whether this can serialize save",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 156,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "GetWriteSecurity",
            "desc": "Returns the member's write security as a string",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 169,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "GetReadSecurity",
            "desc": "Returns the member's read security as a string",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 182,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsProperty",
            "desc": "Returns whether the member is a property.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 195,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsFunction",
            "desc": "Returns whether the member is a function (i.e. method).",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 203,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsCallback",
            "desc": "Returns whether the member is a callback.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 211,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsNotScriptable",
            "desc": "Returns whether a script can modify it.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 219,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsNotReplicated",
            "desc": "Returns whether the member is not replicated.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 227,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsDeprecated",
            "desc": "Returns whether the member is deprecated..",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 234,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "IsHidden",
            "desc": "Returns whether this api member is hidden.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 242,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "GetTags",
            "desc": "Returns a list of tags. Do not modify this list.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{string}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 250,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        },
        {
            "name": "HasTag",
            "desc": "Retrieves whether the member has a tag or not.",
            "params": [
                {
                    "name": "tagName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 259,
                "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RobloxApiMember",
    "desc": "Represents a specific member of a class. This could be a property or event, or method, or callback.",
    "source": {
        "line": 5,
        "path": "src/roblox-api-dump/src/Server/RobloxApiMember.lua"
    }
}