Skip to main content

SoundGroupPathUtils

This was deprecated in 1.54.0
Use [InstancePathUtils] from `@quenty/instance-path` instead.

Functions​

isSoundGroupPath​

deprecated in 1.54.0
</>
This was deprecated in 1.54.0
Use [InstancePathUtils.isInstancePath] instead.
SoundGroupPathUtils.isSoundGroupPath(soundGroupPath: string) → boolean

Checks if the given string is a valid sound group path.

toPathTable​

deprecated in 1.54.0
</>
This was deprecated in 1.54.0
Use [InstancePathUtils.toPathTable] instead.
SoundGroupPathUtils.toPathTable(soundGroupPath: InstancePath) → InstancePathTable

Converts a sound group path into a table of strings.

findSoundGroup​

deprecated in 1.54.0
</>
This was deprecated in 1.54.0
Use [InstancePathUtils.findInstance] instead.
SoundGroupPathUtils.findSoundGroup(
soundGroupPath: InstancePath,
root: Instance?
) → SoundGroup?

Finds the sound group at the given path, searching from SoundService if no root is given.

findOrCreateSoundGroup​

deprecated in 1.54.0
</>
This was deprecated in 1.54.0
Use [InstancePathUtils.findOrCreateInstance] instead.
SoundGroupPathUtils.findOrCreateSoundGroup(
soundGroupPath: InstancePath,
root: Instance?
) → SoundGroup

Finds the sound group at the given path, constructing any missing sound groups along the way. Searches from SoundService if no root is given.

Show raw api
{
    "functions": [
        {
            "name": "isSoundGroupPath",
            "desc": "Checks if the given string is a valid sound group path.",
            "params": [
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "deprecated": {
                "version": "1.54.0",
                "desc": "Use [InstancePathUtils.isInstancePath] instead."
            },
            "source": {
                "line": 29,
                "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
            }
        },
        {
            "name": "toPathTable",
            "desc": "Converts a sound group path into a table of strings.",
            "params": [
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "InstancePath"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InstancePathTable"
                }
            ],
            "function_type": "static",
            "deprecated": {
                "version": "1.54.0",
                "desc": "Use [InstancePathUtils.toPathTable] instead."
            },
            "source": {
                "line": 40,
                "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
            }
        },
        {
            "name": "findSoundGroup",
            "desc": "Finds the sound group at the given path, searching from [SoundService] if no root is given.",
            "params": [
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "InstancePath"
                },
                {
                    "name": "root",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SoundGroup?"
                }
            ],
            "function_type": "static",
            "deprecated": {
                "version": "1.54.0",
                "desc": "Use [InstancePathUtils.findInstance] instead."
            },
            "source": {
                "line": 52,
                "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
            }
        },
        {
            "name": "findOrCreateSoundGroup",
            "desc": "Finds the sound group at the given path, constructing any missing sound groups along the\nway. Searches from [SoundService] if no root is given.",
            "params": [
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "InstancePath"
                },
                {
                    "name": "root",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SoundGroup"
                }
            ],
            "function_type": "static",
            "deprecated": {
                "version": "1.54.0",
                "desc": "Use [InstancePathUtils.findOrCreateInstance] instead."
            },
            "source": {
                "line": 67,
                "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SoundGroupPathUtils",
    "desc": "",
    "deprecated": {
        "version": "1.54.0",
        "desc": "Use [InstancePathUtils] from `@quenty/instance-path` instead."
    },
    "source": {
        "line": 6,
        "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
    }
}