self:list_fx

Client

Retrieves the names of all audio effects applied to the audio-3d instance


Syntax

local effects = self:list_fx()

Parameters

No parameters are accepted by this function

Returns

TypeNameDescription
tableeffectsArray of effect name strings in chain order

Examples

List all effects on an audio-3d instance
local entity = core.audio_3d.create("sounds/ambient.ogg")

entity:add_fx("my_reverb", "reverb")
entity:add_fx("my_amp", "amplify", { volume_db = 6.0 })

core.engine.iprint(entity:list_fx())

--[[
Output:
{
    1: 'my_reverb'
    2: 'my_amp'
}
]]

On this page