Skip to main content

AudioBuilder

This item only works when running on the client. Client

Functional module used for constructing immutable audio configurations and assembling wire chains.

Functions​

create​

</>
AudioBuilder.create() → AudioConfig

Instantiates a blank AudioConfig table.

AddEffect​

</>
AudioBuilder.AddEffect(
config: AudioConfig,--

Current config object.

effectId: AudioEffectId,--

Valid Audio effect class name.

properties: {[string]: any}?--

Property overrides for the effect instance.

) → AudioConfig

Appends an audio effect to an immutable AudioConfig.

Build​

</>
AudioBuilder.Build(
config: AudioConfig,--

Configuration table containing effect definitions.

source: Instance,--

Audio emitter/input source.

target: Instance,--

Audio listener/output target.

janitor: Janitor--

Janitor instance tracking lifetime of wires and created effects.

) → {Instance}--

Array of created effect instances.

Builds instances and connects wires between audio source and target.

Show raw api
{
    "functions": [
        {
            "name": "create",
            "desc": "Instantiates a blank AudioConfig table.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AudioConfig"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/Client/AudioBuilder.lua"
            }
        },
        {
            "name": "AddEffect",
            "desc": "Appends an audio effect to an immutable AudioConfig.",
            "params": [
                {
                    "name": "config",
                    "desc": "Current config object.",
                    "lua_type": "AudioConfig"
                },
                {
                    "name": "effectId",
                    "desc": "Valid Audio effect class name.",
                    "lua_type": "AudioEffectId"
                },
                {
                    "name": "properties",
                    "desc": "Property overrides for the effect instance.",
                    "lua_type": "{[string]: any}?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AudioConfig"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 45,
                "path": "src/Client/AudioBuilder.lua"
            }
        },
        {
            "name": "Build",
            "desc": "Builds instances and connects wires between audio source and target.",
            "params": [
                {
                    "name": "config",
                    "desc": "Configuration table containing effect definitions.",
                    "lua_type": "AudioConfig"
                },
                {
                    "name": "source",
                    "desc": "Audio emitter/input source.",
                    "lua_type": "Instance"
                },
                {
                    "name": "target",
                    "desc": "Audio listener/output target.",
                    "lua_type": "Instance"
                },
                {
                    "name": "janitor",
                    "desc": "Janitor instance tracking lifetime of wires and created effects.",
                    "lua_type": "Janitor"
                }
            ],
            "returns": [
                {
                    "desc": "Array of created effect instances.",
                    "lua_type": "{Instance}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/Client/AudioBuilder.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AudioBuilder",
    "desc": "Functional module used for constructing immutable audio configurations and assembling wire chains.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 4,
        "path": "src/Client/AudioBuilder.lua"
    }
}