Skip to main content

SoundGroupPathUtils

Functions​

isSoundGroupPath​

</>
SoundGroupPathUtils.isSoundGroupPath(soundGroupPath: string) → boolean

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

toPathTable​

</>
SoundGroupPathUtils.toPathTable(soundGroupPath: string) → {string}

Converts a sound group path into a table of strings.

findSoundGroup​

</>
SoundGroupPathUtils.findSoundGroup(
soundGroupPath: string,
root: Instance?
) → SoundGroup

Converts a table of strings into a sound group path.

findOrCreateSoundGroup​

</>
SoundGroupPathUtils.findOrCreateSoundGroup(
soundGroupPath: string,
root: Instance?
) → SoundGroup

Converts a table of strings into a sound group path.

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",
            "source": {
                "line": 16,
                "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": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ string }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 26,
                "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
            }
        },
        {
            "name": "findSoundGroup",
            "desc": "Converts a table of strings into a sound group path.",
            "params": [
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "root",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SoundGroup"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
            }
        },
        {
            "name": "findOrCreateSoundGroup",
            "desc": "Converts a table of strings into a sound group path.",
            "params": [
                {
                    "name": "soundGroupPath",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "root",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SoundGroup"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 65,
                "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SoundGroupPathUtils",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/soundgroups/src/Shared/Utils/SoundGroupPathUtils.lua"
    }
}