Audio 3D

self:set_dimension

Client

Sets the dimension of the audio-3d instance

local status = self:set_dimension(
    dimension
)

Audio is only heard from the dimension it is in.

Hearing — the client mutes the instance while its active camera is in a different dimension. Playback keeps running while muted, so the timeline stays in sync.
Attached — an instance parented to another entity always follows its parent's dimension and cannot set its own, the call raises an error. Detaching it keeps the dimension it had.

Type	Name	Description
`int`	dimension	Dimension id to apply Must be within `0` to `65535`

Type	Name	Description
`bool`	status	`true` on successful execution, `false` otherwise

Set the dimension of an audio-3d instance

local entity = core.audio_3d.create("sounds/ambient.ogg", true)

entity:set_dimension(1)

self:set_global_position

Sets the global world position of the audio-3d instance

self:set_parent

Attaches the audio-3d instance to another entity, or detaches it when no entity is given