Skip to main content

InstancedTypes

Types used for Instances in the Schema and Conversions.

Types​

SoundGroups​

</>
type SoundGroups = {[string]: SoundGroup}

Dictionary of SoundGroups from the Schema.

SoundDefinitionInstanced​

</>
type SoundDefinitionInstanced = Sound & SoundChildrenInstanced

A Sound with SoundEffects parented.

SoundChildrenInstanced​

</>
interface SoundChildrenInstanced {
TremoloSoundEffect: TremoloSoundEffect?
ReverbSoundEffect: ReverbSoundEffect?
PitchShiftSoundEffect: PitchShiftSoundEffect?
FlangeSoundEffect: FlangeSoundEffect?
EqualizerSoundEffect: EqualizerSoundEffect?
EchoSoundEffect: EchoSoundEffect?
DistortionSoundEffect: DistortionSoundEffect?
CompressorSoundEffect: CompressorSoundEffect?
ChorusSoundEffect: ChorusSoundEffect?
}

All possible SoundEffects to find within a Sound.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "SoundGroups",
            "desc": "Dictionary of `SoundGroups` from the `Schema`.",
            "lua_type": "{[string]: SoundGroup}",
            "source": {
                "line": 55,
                "path": "lib/Types.luau"
            }
        },
        {
            "name": "SoundDefinitionInstanced",
            "desc": "A `Sound` with `SoundEffects` parented.",
            "lua_type": "Sound & SoundChildrenInstanced",
            "source": {
                "line": 65,
                "path": "lib/Types.luau"
            }
        },
        {
            "name": "SoundChildrenInstanced",
            "desc": "All possible `SoundEffects` to find within a `Sound`.",
            "fields": [
                {
                    "name": "TremoloSoundEffect",
                    "lua_type": "TremoloSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "ReverbSoundEffect",
                    "lua_type": "ReverbSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "PitchShiftSoundEffect",
                    "lua_type": "PitchShiftSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "FlangeSoundEffect",
                    "lua_type": "FlangeSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "EqualizerSoundEffect",
                    "lua_type": "EqualizerSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "EchoSoundEffect",
                    "lua_type": "EchoSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "DistortionSoundEffect",
                    "lua_type": "DistortionSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "CompressorSoundEffect",
                    "lua_type": "CompressorSoundEffect?",
                    "desc": ""
                },
                {
                    "name": "ChorusSoundEffect",
                    "lua_type": "ChorusSoundEffect?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 83,
                "path": "lib/Types.luau"
            }
        }
    ],
    "name": "InstancedTypes",
    "desc": "Types used for `Instances` in the `Schema` and `Conversions`.",
    "source": {
        "line": 47,
        "path": "lib/Types.luau"
    }
}