Skip to main content

soundInitializerUtil

A simple utility module for initializing sounds used in conjunction with soundUtil.

Properties​

GOAL_SOUND_VOLUME_ATTRIBUTE​

Constant
</>
soundInitializerUtil.GOAL_SOUND_VOLUME_ATTRIBUTE: "GoalSoundVolume"
Not Accessible

Constant, not accesible within soundInitializerUtil.

DEFAULT_SOUND_VOLUME_LERP_IN_ALPHA​

Constant
</>
soundInitializerUtil.DEFAULT_SOUND_VOLUME_LERP_IN_ALPHA: 4
Not Accessible

Constant, not accesible within soundInitializerUtil.

DEFAULT_SOUND_VOLUME_LERP_OUT_ALPHA​

Constant
</>
soundInitializerUtil.DEFAULT_SOUND_VOLUME_LERP_OUT_ALPHA: 4
Not Accessible

Constant, not accesible within soundInitializerUtil.

Functions​

initForBasicFadingInAndOut​

</>
soundInitializerUtil.initForBasicFadingInAndOut(
sound: Sound,
data: {
goalSoundVolumeIn: number,
goalSoundVolumeOut: number,
lerpInAlpha: number?,
lerpOutAlpha: number?,
}
) → ()

Initializes the given sound for basic fading in and fading out. If lerpInAlpha and lerpOutAlpha are not specified, they'll default to soundInitializerUtil.DEFAULT_SOUND_VOLUME_LERP_IN_ALPHA.

Show raw api
{
    "functions": [
        {
            "name": "initForBasicFadingInAndOut",
            "desc": "Initializes the given `sound` for basic fading in and fading out. If `lerpInAlpha` and `lerpOutAlpha` are not\nspecified, they'll default to [soundInitializerUtil.DEFAULT_SOUND_VOLUME_LERP_IN_ALPHA].",
            "params": [
                {
                    "name": "sound",
                    "desc": "",
                    "lua_type": "Sound"
                },
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "{\n\t\tgoalSoundVolumeIn: number,\n\t\tgoalSoundVolumeOut: number,\n\t\tlerpInAlpha: number?,\n\t\tlerpOutAlpha: number?,\n\t}\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 49,
                "path": "src/soundInitializerUtil/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "GOAL_SOUND_VOLUME_ATTRIBUTE",
            "desc": " \n\n:::warning Not Accessible\nConstant, not accesible within `soundInitializerUtil`.\n:::",
            "lua_type": "\"GoalSoundVolume\"",
            "tags": [
                "Constant"
            ],
            "source": {
                "line": 16,
                "path": "src/soundInitializerUtil/init.luau"
            }
        },
        {
            "name": "DEFAULT_SOUND_VOLUME_LERP_IN_ALPHA",
            "desc": " \n\n:::warning Not Accessible\nConstant, not accesible within `soundInitializerUtil`.\n:::",
            "lua_type": "4",
            "tags": [
                "Constant"
            ],
            "source": {
                "line": 26,
                "path": "src/soundInitializerUtil/init.luau"
            }
        },
        {
            "name": "DEFAULT_SOUND_VOLUME_LERP_OUT_ALPHA",
            "desc": " \n\n:::warning Not Accessible\nConstant, not accesible within `soundInitializerUtil`.\n:::",
            "lua_type": "4",
            "tags": [
                "Constant"
            ],
            "source": {
                "line": 36,
                "path": "src/soundInitializerUtil/init.luau"
            }
        }
    ],
    "types": [],
    "name": "soundInitializerUtil",
    "desc": "A simple utility module for initializing sounds used in conjunction with [soundUtil].",
    "source": {
        "line": 6,
        "path": "src/soundInitializerUtil/init.luau"
    }
}