Skip to main content

SimpleLoopedSoundPlayer

Functions​

SetSoundGroup​

</>
SimpleLoopedSoundPlayer.SetSoundGroup(
soundGroup: SoundGroup?
) → ()

Sets the SoundGroup of the internal Sound.

SetVolumeMultiplier​

</>
SimpleLoopedSoundPlayer.SetVolumeMultiplier(
volume: number
) → ()

Sets the volume multiplier for the sound player.

PromiseSustain​

</>
SimpleLoopedSoundPlayer.PromiseSustain(self: SimpleLoopedSoundPlayer) → Promise.Promise<()>

Promises indefinitely until the sound player is destroyed.

PromiseLoopDone​

</>
SimpleLoopedSoundPlayer.PromiseLoopDone(self: SimpleLoopedSoundPlayer) → Promise.Promise<()>

Promises until the current loop is done.

Show raw api
{
    "functions": [
        {
            "name": "SetSoundGroup",
            "desc": "Sets the SoundGroup of the internal Sound.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SimpleLoopedSoundPlayer"
                },
                {
                    "name": "soundGroup",
                    "desc": "",
                    "lua_type": "SoundGroup?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "src/soundplayer/src/Client/Loops/SimpleLoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SetVolumeMultiplier",
            "desc": "Sets the volume multiplier for the sound player.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SimpleLoopedSoundPlayer"
                },
                {
                    "name": "volume",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "src/soundplayer/src/Client/Loops/SimpleLoopedSoundPlayer.lua"
            }
        },
        {
            "name": "PromiseSustain",
            "desc": "Promises indefinitely until the sound player is destroyed.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SimpleLoopedSoundPlayer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/soundplayer/src/Client/Loops/SimpleLoopedSoundPlayer.lua"
            }
        },
        {
            "name": "PromiseLoopDone",
            "desc": "Promises until the current loop is done.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SimpleLoopedSoundPlayer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 87,
                "path": "src/soundplayer/src/Client/Loops/SimpleLoopedSoundPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SimpleLoopedSoundPlayer",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/soundplayer/src/Client/Loops/SimpleLoopedSoundPlayer.lua"
    }
}