Sound

Entity

Sound Reference

Entity Component

Sound Reference sound_ref

Reference to a sound asset with playback and spatialization controls.

Schema

attenuationModel

Unsigned Byte

Default:0(No Attenuation)

Min:0

Distance attenuation model.

0No Attenuation1Inverse Distance2Linear Distance3Exponential Distance

Distance attenuation model.

attenuationRolloffFactor

Float

Default:1

Min:0

Rolloff factor for distance attenuation.

Rolloff factor for distance attenuation.

autoPlayOnStart

Boolean

Default:false

Autoplay when the simulation starts.

Autoplay when the simulation starts.

dopplerFactor

Float

Default:1

Min:0

Scale factor for the Doppler effect.

Scale factor for the Doppler effect.

inaudibleBehavior

Unsigned Byte

Default:0(Tick)

Min:0

Behavior when the sound becomes inaudible.

0Tick1Don't Tick2Kill

Behavior when the sound becomes inaudible.

looping

Boolean

Default:false

Whether the sound loops.

Whether the sound loops.

maxDistance

Float(m)

Default:50

Min:0

Distance beyond which the sound is inaudible (meters).

Distance beyond which the sound is inaudible (meters).

minDistance

Float(m)

Default:5

Min:0

Distance at which the sound stays at max volume (meters).

Distance at which the sound stays at max volume (meters).

pan

Float

Default:0

Min:-1

Max:1

Stereo pan. −1 = left, 1 = right.

Stereo pan. −1 = left, 1 = right.

playSpeed

Float

Default:1

Playback speed multiplier (1.0 = normal).

Playback speed multiplier (1.0 = normal).

value

UUID(sound Asset)

Referenced sound (UUID).

Referenced sound (UUID).

volume

Float

Default:1

Min:0

Max:1

Playback volume [0..1].

Playback volume [0..1].

View in component reference

Creates an entity that emits a 3d spatialized sound.