self:remove_fx

Client

Removes an audio effect from the audio-2d instance's effect chain


Syntax

local status = self:remove_fx(
    name
)

Parameters

TypeNameDescription
stringnameName of the effect to remove

Returns

TypeNameDescription
boolstatustrue on successful execution, false otherwise

Examples

Remove an effect from an audio-2d instance
local entity = core.audio_2d.create("sounds/ambient.ogg")

entity:add_fx("my_reverb", "reverb", { wet = 0.5 })
entity:remove_fx("my_reverb")

On this page