Show raw api
{
"functions": [
{
"name": "play",
"desc": "",
"params": [
{
"name": "parent",
"desc": "",
"lua_type": "Instance"
},
{
"name": "speechObject",
"desc": "",
"lua_type": "SpeechObject"
},
{
"name": "playSettings",
"desc": "",
"lua_type": "PlaySettings?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 25,
"path": "src/Functions/Play.luau"
}
},
{
"name": "init",
"desc": "",
"params": [],
"returns": [],
"function_type": "static",
"private": true,
"source": {
"line": 67,
"path": "src/Functions/Play.luau"
}
},
{
"name": "generateMainSounds",
"desc": "Loops through the `audioIds` of the `speechObject`, attempts to loads the\naudio files.\n\nSounds that can't be loaded are added to the rejectedCount and the\nrejectedId array.",
"params": [
{
"name": "audioIds",
"desc": "",
"lua_type": "{string}"
},
{
"name": "trove",
"desc": "",
"lua_type": "Trove"
},
{
"name": "playSettings",
"desc": "",
"lua_type": "PlaySettings?"
}
],
"returns": [
{
"desc": "",
"lua_type": "{Sound}"
},
{
"desc": "rejectedCount",
"lua_type": "number"
},
{
"desc": "rejectedIds",
"lua_type": "{string}"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 91,
"path": "src/Functions/Play.luau"
}
},
{
"name": "generateSoundClips",
"desc": "",
"params": [
{
"name": "soundClips",
"desc": "",
"lua_type": "{SoundClip}"
},
{
"name": "mainSounds",
"desc": "",
"lua_type": "{Sound}"
},
{
"name": "trove",
"desc": "",
"lua_type": "Trove"
}
],
"returns": [
{
"desc": "",
"lua_type": "{Sound}"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 182,
"path": "src/Functions/Play.luau"
}
},
{
"name": "generatePlaylist",
"desc": "",
"params": [
{
"name": "playlist",
"desc": "the playlist from a `SpeechObject`",
"lua_type": "{number|string}"
},
{
"name": "clips",
"desc": "the sounds from `.generateSoundClips()`",
"lua_type": "{Sound}"
},
{
"name": "soundClips",
"desc": "the soundClips from a `SpeechObject`",
"lua_type": "{SoundClip}"
},
{
"name": "trove",
"desc": "",
"lua_type": "Trove"
},
{
"name": "parent",
"desc": "",
"lua_type": "Instance"
}
],
"returns": [
{
"desc": "",
"lua_type": "Playlist"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 225,
"path": "src/Functions/Play.luau"
}
},
{
"name": "play",
"desc": "",
"params": [
{
"name": "playlist",
"desc": "",
"lua_type": "Playlist"
}
],
"returns": [],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 264,
"path": "src/Functions/Play.luau"
}
},
{
"name": "applyEffects",
"desc": "",
"params": [
{
"name": "sound",
"desc": "",
"lua_type": "Sound"
},
{
"name": "soundClip",
"desc": "",
"lua_type": "SoundClip"
},
{
"name": "trove",
"desc": "",
"lua_type": "Trove"
}
],
"returns": [],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 302,
"path": "src/Functions/Play.luau"
}
},
{
"name": "makeFolder",
"desc": "",
"params": [
{
"name": "parent",
"desc": "",
"lua_type": "Instance"
},
{
"name": "name",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "Folder"
}
],
"function_type": "static",
"private": true,
"ignore": true,
"source": {
"line": 405,
"path": "src/Functions/Play.luau"
}
}
],
"properties": [],
"types": [
{
"name": "Playlist",
"desc": "",
"lua_type": "{number | {sound: Sound, timeStart: number, timeEnd: number}}",
"private": true,
"source": {
"line": 426,
"path": "src/Functions/Play.luau"
}
},
{
"name": "PlaySettings",
"desc": "The settings used when playing a speechObject",
"fields": [
{
"name": "SoundGroup",
"lua_type": "SoundGroup?",
"desc": ""
}
],
"source": {
"line": 438,
"path": "src/Functions/Play.luau"
}
}
],
"name": "Play",
"desc": "",
"private": true,
"source": {
"line": 6,
"path": "src/Functions/Play.luau"
}
}