self:is_fx_enabled

Client

Checks whether an audio effect on the audio-3d instance's effect chain is enabled


Syntax

local result = self:is_fx_enabled(
    name
)

Parameters

TypeNameDescription
stringnameName of the effect to check for

Returns

TypeNameDescription
boolresulttrue if the effect is enabled, false otherwise

Examples

Check whether an effect is enabled on an audio-3d instance
local entity = core.audio_3d.create("sounds/ambient.ogg")

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

core.engine.print("info", "Fx Enabled:", entity:is_fx_enabled("my_reverb")) -- true

On this page