Skip to main content

SoundEffectService

Handles applying global volume and effects to specific sounds in a group based upon a path.

Functions​

RegisterSFX​

</>
SoundEffectService.RegisterSFX(
sound: Sound,
soundGroupPath: string?--

Optional

) → ()

Assigns the sound group for the given

GetOrCreateSoundGroup​

</>
SoundEffectService.GetOrCreateSoundGroup(
soundGroupPath: string
) → SoundGroup

Returns the SoundGroup for the given path, creating it if it does not exist.

GetSoundGroup​

</>
SoundEffectService.GetSoundGroup(
soundGroupPath: string
) → SoundGroup

Returns the SoundGroup for the given path, or nil if it does not exist.

PromiseCreateVolumeMultiplier​

</>
SoundEffectService:PromiseCreateVolumeMultiplier(soundGroupPath: string) → Promise<NumberValue>

Creates a NumberValue multiplier for the given sound group path.

Destroy (or unparent) the returned NumberValue to remove the multiplier.

Show raw api
{
    "functions": [
        {
            "name": "RegisterSFX",
            "desc": "Assigns the sound group for the given",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SoundEffectService"
                },
                {
                    "name": "sound",
                    "desc": "",
                    "lua_type": "Sound"
                },
                {
                    "name": "soundGroupPath",
                    "desc": "Optional",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 62,
                "path": "src/soundgroups/src/Shared/SoundEffectService.lua"
            }
        },
        {
            "name": "PromiseCreateVolumeMultiplier",
            "desc": "Creates a NumberValue multiplier for the given sound group path.\n\nDestroy (or unparent) the returned NumberValue to remove the multiplier.",
            "params": [
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<NumberValue>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 77,
                "path": "src/soundgroups/src/Shared/SoundEffectService.lua"
            }
        },
        {
            "name": "GetOrCreateSoundGroup",
            "desc": "Returns the SoundGroup for the given path, creating it if it does not exist.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SoundEffectService"
                },
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SoundGroup"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 97,
                "path": "src/soundgroups/src/Shared/SoundEffectService.lua"
            }
        },
        {
            "name": "GetSoundGroup",
            "desc": "Returns the SoundGroup for the given path, or nil if it does not exist.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SoundEffectService"
                },
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SoundGroup"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 120,
                "path": "src/soundgroups/src/Shared/SoundEffectService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SoundEffectService",
    "desc": "Handles applying global volume and effects to specific sounds in a group based upon a path.",
    "source": {
        "line": 7,
        "path": "src/soundgroups/src/Shared/SoundEffectService.lua"
    }
}