Skip to main content

SoundEffectsList

Holds sound effects to be applied

Functions​

HasEffects​

</>
SoundEffectsList.HasEffects(self: SoundEffectsList) → boolean

Returns the number of effects that are currently applied.

ObserveHasEffects​

</>
SoundEffectsList.ObserveHasEffects(self: SoundEffectsList) → Observable<boolean>

Observes whether the list has any effects.

IsActive​

</>
SoundEffectsList.IsActive(self: SoundEffectsList) → boolean

Rounds whether the list is effective or not.

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": "HasEffects",
            "desc": "Returns the number of effects that are currently applied.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SoundEffectsList"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
            }
        },
        {
            "name": "ObserveHasEffects",
            "desc": "Observes whether the list has any effects.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SoundEffectsList"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
            }
        },
        {
            "name": "IsActive",
            "desc": "Rounds whether the list is effective or not.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SoundEffectsList"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 82,
                "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
            }
        },
        {
            "name": "PushEffect",
            "desc": "Pushes an affect that will be applied to the sound group or sound\nas it exists.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SoundEffectsList"
                },
                {
                    "name": "effect",
                    "desc": "",
                    "lua_type": "(instance) -> MaidTask"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup call",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 93,
                "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": "self",
                    "desc": "",
                    "lua_type": "SoundEffectsList"
                },
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "SoundGroup | Sound"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup call",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 106,
                "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SoundEffectsList",
    "desc": "Holds sound effects to be applied",
    "source": {
        "line": 7,
        "path": "src/soundgroups/src/Shared/Effects/SoundEffectsList.lua"
    }
}