Skip to main content

SoundPromiseUtils

Utility functions involving sounds and their state

Functions​

promiseLoaded​

</>
SoundPromiseUtils.promiseLoaded(sound: Sound) → Promise

Promises that a sound is loaded

promisePlayed​

</>
SoundPromiseUtils.promisePlayed(sound: Sound | VideoFrame) → Promise.Promise<()>

Promise that resolves when the sound is done playing

promiseLooped​

</>
SoundPromiseUtils.promiseLooped(sound: Sound) → Promise.Promise<()>

Promise that resolves when the sound is done looping

promiseAllSoundsLoaded​

</>
SoundPromiseUtils.promiseAllSoundsLoaded(sounds: {Sound}) → Promise

Promises that all sounds are loaded

Show raw api
{
    "functions": [
        {
            "name": "promiseLoaded",
            "desc": "Promises that a sound is loaded",
            "params": [
                {
                    "name": "sound",
                    "desc": "",
                    "lua_type": "Sound"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/sounds/src/Shared/SoundPromiseUtils.lua"
            }
        },
        {
            "name": "promisePlayed",
            "desc": "Promise that resolves when the sound is done playing",
            "params": [
                {
                    "name": "sound",
                    "desc": "",
                    "lua_type": "Sound | VideoFrame"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 51,
                "path": "src/sounds/src/Shared/SoundPromiseUtils.lua"
            }
        },
        {
            "name": "promiseLooped",
            "desc": "Promise that resolves when the sound is done looping",
            "params": [
                {
                    "name": "sound",
                    "desc": "",
                    "lua_type": "Sound"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 60,
                "path": "src/sounds/src/Shared/SoundPromiseUtils.lua"
            }
        },
        {
            "name": "promiseAllSoundsLoaded",
            "desc": "Promises that all sounds are loaded",
            "params": [
                {
                    "name": "sounds",
                    "desc": "",
                    "lua_type": "{ Sound }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 77,
                "path": "src/sounds/src/Shared/SoundPromiseUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SoundPromiseUtils",
    "desc": "Utility functions involving sounds and their state",
    "source": {
        "line": 6,
        "path": "src/sounds/src/Shared/SoundPromiseUtils.lua"
    }
}