Show raw api
{
"functions": [
{
"name": "generate",
"desc": "",
"params": [
{
"name": "speechData",
"desc": "",
"lua_type": "SpeechData"
}
],
"returns": [
{
"desc": "",
"lua_type": "Promise -> SpeechObject"
}
],
"function_type": "static",
"source": {
"line": 30,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "init",
"desc": "",
"params": [],
"returns": [],
"function_type": "static",
"private": true,
"source": {
"line": 67,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "isModeValid",
"desc": "",
"params": [
{
"name": "speechMode",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 88,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "convertSpeechDataToModifier",
"desc": "",
"params": [
{
"name": "speechData",
"desc": "",
"lua_type": "SpeechData"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 105,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "filterMessage",
"desc": "",
"params": [
{
"name": "message",
"desc": "",
"lua_type": "string"
},
{
"name": "blacklist",
"desc": "",
"lua_type": "Blacklist?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 141,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "splitByModifiers",
"desc": "",
"params": [
{
"name": "message",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "DeconstructedMessage"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 173,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "validateModifiers",
"desc": "Converts all modifiers into valid ones",
"params": [
{
"name": "message",
"desc": "",
"lua_type": "DeconstructedMessage"
},
{
"name": "permissionLevel",
"desc": "",
"lua_type": "string?"
},
{
"name": "availableVoicepacks",
"desc": "",
"lua_type": "{string}?"
}
],
"returns": [
{
"desc": "",
"lua_type": "ValidatedMessage"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 230,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "getSpeechObject",
"desc": "",
"params": [
{
"name": "message",
"desc": "",
"lua_type": "ValidatedMessage"
},
{
"name": "initialModifier",
"desc": "",
"lua_type": "Settings.SpeechSettings"
}
],
"returns": [
{
"desc": "",
"lua_type": "SpeechObject"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 521,
"path": "src/Functions/Generate.luau"
}
}
],
"properties": [],
"types": [
{
"name": "DeconstructedMessage",
"desc": "",
"lua_type": "{string | {[string]: string}}",
"source": {
"line": 744,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "Modifier",
"desc": "",
"fields": [
{
"name": "[Command]",
"lua_type": "any?",
"desc": ""
},
{
"name": "effects",
"lua_type": "{[SoundEffects.Commands]: number}?",
"desc": ""
},
{
"name": "reset",
"lua_type": "{all: boolean?, commands: {Command}?, effects: SoundEffects.EffectValues?}?",
"desc": ""
}
],
"private": true,
"source": {
"line": 756,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "ValidatedMessage",
"desc": "",
"lua_type": "{string|{[Command]: any}}",
"source": {
"line": 771,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "SoundClip",
"desc": "",
"fields": [
{
"name": "audio",
"lua_type": "number",
"desc": ""
},
{
"name": "timeStart",
"lua_type": "number",
"desc": ""
},
{
"name": "timeEnd",
"lua_type": "number",
"desc": ""
},
{
"name": "speed",
"lua_type": "number",
"desc": ""
},
{
"name": "volume",
"lua_type": "number",
"desc": ""
},
{
"name": "effects",
"lua_type": "SoundEffects.Settings?",
"desc": ""
}
],
"private": true,
"source": {
"line": 809,
"path": "src/Functions/Generate.luau"
}
},
{
"name": "SpeechObject",
"desc": "",
"fields": [
{
"name": "audioIds",
"lua_type": "Array<SoundId>",
"desc": ""
},
{
"name": "soundClips",
"lua_type": "Array<SoundClip>",
"desc": "A dictionary where the index is a string'ified number"
},
{
"name": "playlist",
"lua_type": "Array<number | string>",
"desc": ""
},
{
"name": "duration",
"lua_type": "number",
"desc": ""
}
],
"private": true,
"source": {
"line": 829,
"path": "src/Functions/Generate.luau"
}
}
],
"name": "Generate",
"desc": "",
"private": true,
"source": {
"line": 6,
"path": "src/Functions/Generate.luau"
}
}