Skip to main content

LoopedSoundPlayer

Functions​

SetCrossFadeTime​

</>
LoopedSoundPlayer.SetCrossFadeTime(
crossFadeTime: ValueObject.Mountable<number>
) → () → ()

Sets the cross fade time for the LoopedSoundPlayer.

SetVolumeMultiplier​

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

Sets the volume multiplier for the LoopedSoundPlayer.

SetSoundGroup​

</>
LoopedSoundPlayer.SetSoundGroup(
soundGroup: ValueObject.Mountable<SoundGroup?>
) → () → ()

Sets the sound group for the LoopedSoundPlayer.

SetBPM​

</>
LoopedSoundPlayer.SetBPM(
bpm: number?
) → ()

Sets the BPM for syncing sound playback.

SetSoundParent​

</>
LoopedSoundPlayer.SetSoundParent(
parent: Instance?
) → ()

Sets the parent instance for the sound.

SetDoSyncSoundPlayback​

</>
LoopedSoundPlayer.SetDoSyncSoundPlayback(
doSyncSoundPlayback: boolean
) → ()

Sets whether to sync sound playback to BPM.

SwapToChoice​

</>
LoopedSoundPlayer.SwapToChoice(
soundIdList: {SoundUtils.SoundId},
loopSchedule: SoundLoopScheduleUtils.SoundLoopSchedule?
) → ()

Swaps to a random choice from the provided list of sound IDs on loop.

PlayOnce​

</>
LoopedSoundPlayer.PlayOnce(
soundId: SoundUtils.SoundId,
loopSchedule: SoundLoopScheduleUtils.SoundLoopSchedule?
) → ()

Plays the sound once

SwapOnLoop​

</>
LoopedSoundPlayer.SwapOnLoop(
soundId: SoundUtils.SoundId,
loopSchedule: SoundLoopScheduleUtils.SoundLoopSchedule?
) → ()

Swaps the sound on the next loop

PlayOnceOnLoop​

</>
LoopedSoundPlayer.PlayOnceOnLoop(
soundId: SoundUtils.SoundId,
loopSchedule: SoundLoopScheduleUtils.SoundLoopSchedule?
) → ()

Plays the sound once on the next loop

StopAfterLoop​

</>
LoopedSoundPlayer.StopAfterLoop(self: LoopedSoundPlayer) → ()

Stops playback after the current loop finishes.

PromiseLoopDone​

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

Promises that resolve when the current loop is done.

PromiseSustain​

</>
LoopedSoundPlayer.PromiseSustain(_self: LoopedSoundPlayer) → Promise.Promise<()>

Promises that never resolve, keeping the sound player alive.

GetSound​

</>
LoopedSoundPlayer.GetSound(self: LoopedSoundPlayer) → Sound?

Gets the currently active sound instance.

Show raw api
{
    "functions": [
        {
            "name": "SetCrossFadeTime",
            "desc": "Sets the cross fade time for the LoopedSoundPlayer.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "crossFadeTime",
                    "desc": "",
                    "lua_type": "ValueObject.Mountable<number>\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 88,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SetVolumeMultiplier",
            "desc": "Sets the volume multiplier for the LoopedSoundPlayer.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "volume",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 98,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SetSoundGroup",
            "desc": "Sets the sound group for the LoopedSoundPlayer.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "soundGroup",
                    "desc": "",
                    "lua_type": "ValueObject.Mountable<SoundGroup?>\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SetBPM",
            "desc": "Sets the BPM for syncing sound playback.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "bpm",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 117,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SetSoundParent",
            "desc": "Sets the parent instance for the sound.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 126,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SetDoSyncSoundPlayback",
            "desc": "Sets whether to sync sound playback to BPM.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "doSyncSoundPlayback",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 152,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SwapToChoice",
            "desc": "Swaps to a random choice from the provided list of sound IDs on loop.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "soundIdList",
                    "desc": "",
                    "lua_type": "{ SoundUtils.SoundId }"
                },
                {
                    "name": "loopSchedule",
                    "desc": "",
                    "lua_type": "SoundLoopScheduleUtils.SoundLoopSchedule?\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 337,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "PlayOnce",
            "desc": "Plays the sound once",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "soundId",
                    "desc": "",
                    "lua_type": "SoundUtils.SoundId"
                },
                {
                    "name": "loopSchedule",
                    "desc": "",
                    "lua_type": "SoundLoopScheduleUtils.SoundLoopSchedule?\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 363,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "SwapOnLoop",
            "desc": "Swaps the sound on the next loop",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "soundId",
                    "desc": "",
                    "lua_type": "SoundUtils.SoundId"
                },
                {
                    "name": "loopSchedule",
                    "desc": "",
                    "lua_type": "SoundLoopScheduleUtils.SoundLoopSchedule?\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 378,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "PlayOnceOnLoop",
            "desc": "Plays the sound once on the next loop",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                },
                {
                    "name": "soundId",
                    "desc": "",
                    "lua_type": "SoundUtils.SoundId"
                },
                {
                    "name": "loopSchedule",
                    "desc": "",
                    "lua_type": "SoundLoopScheduleUtils.SoundLoopSchedule?\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 393,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "StopAfterLoop",
            "desc": "Stops playback after the current loop finishes.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 461,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "PromiseLoopDone",
            "desc": "Promises that resolve when the current loop is done.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 523,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "PromiseSustain",
            "desc": "Promises that never resolve, keeping the sound player alive.",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise.Promise<()>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 538,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        },
        {
            "name": "GetSound",
            "desc": "Gets the currently active sound instance.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "LoopedSoundPlayer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Sound?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 546,
                "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "LoopedSoundPlayer",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/soundplayer/src/Client/Loops/LoopedSoundPlayer.lua"
    }
}