Skip to main content

Setup

This item is only intended to be used by the module's authors. Private

Functions​

init​

</>
Setup.init(moduleSettings: Settings?) → ()

initCheck​

</>
Setup.initCheck(functionName: string?) → boolean

Returns false if SpeechSynth has not been loaded

Used by the public functions to ensure the library has been loaded

Show raw api
{
    "functions": [
        {
            "name": "init",
            "desc": "",
            "params": [
                {
                    "name": "moduleSettings",
                    "desc": "",
                    "lua_type": "Settings?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/Utility/Setup.luau"
            }
        },
        {
            "name": "initCheck",
            "desc": "Returns false if SpeechSynth has not been loaded\n\nUsed by the public functions to ensure the library has been loaded",
            "params": [
                {
                    "name": "functionName",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/Utility/Setup.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Setup",
    "desc": "",
    "private": true,
    "source": {
        "line": 6,
        "path": "src/Utility/Setup.luau"
    }
}