Skip to main content

Symbol

Functions​

new​

</>
Symbol.new(
Name: string--

The string representing the symbol

) → Symbol

Creates a blank userdata that can be converted into a string.

newNameless​

</>
Symbol.newNameless() → Symbol

Creates a blank symbol.

AsString​

</>
Symbol.AsString(
ThisSymbol: Symbol--

The symbol you're checking

) → Symbol

Equivalent to tostring, gets the string name from a Symbol.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a blank userdata that can be converted into a string.",
            "params": [
                {
                    "name": "Name",
                    "desc": "The string representing the symbol",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Symbol"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 18,
                "path": "src/Packages/_Index/miagobble_symbol@1.0.2/symbol/init.luau"
            }
        },
        {
            "name": "newNameless",
            "desc": "Creates a blank symbol.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Symbol"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 34,
                "path": "src/Packages/_Index/miagobble_symbol@1.0.2/symbol/init.luau"
            }
        },
        {
            "name": "AsString",
            "desc": "Equivalent to `tostring`, gets the string name from a Symbol.",
            "params": [
                {
                    "name": "ThisSymbol",
                    "desc": "The symbol you're checking",
                    "lua_type": "Symbol"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Symbol"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/Packages/_Index/miagobble_symbol@1.0.2/symbol/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Symbol",
    "desc": "",
    "source": {
        "line": 6,
        "path": "src/Packages/_Index/miagobble_symbol@1.0.2/symbol/init.luau"
    }
}