Skip to main content

SoundEffectsList

Functions​

PushEffect​

</>
SoundEffectsList:PushEffect(effect: (instance) → MaidTask) → () → ()--

Cleanup call

Pushes an affect that will be applied to the sound group or sound as it exists.

ApplyEffects​

</>
SoundEffectsList:ApplyEffects(instance: SoundGroup | Sound) → () → ()--

Cleanup call

Pushes an affect that will be applied to the sound group or sound as it exists.

Show raw api
{
    "functions": [
        {
            "name": "PushEffect",
            "desc": "Pushes an affect that will be applied to the sound group or sound\nas it exists.",
            "params": [
                {
                    "name": "effect",
                    "desc": "",
                    "lua_type": "(instance) -> MaidTask"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup call",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 61,
                "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
            }
        },
        {
            "name": "ApplyEffects",
            "desc": "Pushes an affect that will be applied to the sound group or sound\nas it exists.",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "SoundGroup | Sound"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup call",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SoundEffectsList",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
    }
}