Struct AudioSource 

pub struct AudioSource {
    pub clip: String,
    pub volume: f32,
    pub pitch: f32,
    pub looping: bool,
    pub play_on_start: bool,
    pub spatial: bool,
    pub min_distance: f32,
    pub max_distance: f32,
    pub pan: f32,
    pub trigger: bool,
    pub cone_angle: f32,
}

A sound attached to an object: ambience, a radio, a machine hum.

With spatial on, volume follows the distance to the listener (the scene camera) and the sound is panned left/right by where the object is; off, it plays flat with pan.

Fields

clip: String

Clip asset path.

volume: f32

Linear gain.

pitch: f32

Speed / pitch multiplier.

looping: bool

Repeat the clip.

play_on_start: bool

Start when the game starts.

spatial: bool

Treat the object position as the sound position.

min_distance: f32

Full-volume radius in metres (spatial only).

max_distance: f32

Silent beyond this distance in metres (spatial only).

pan: f32

Stereo position when not spatial, -1 left .. +1 right.

trigger: bool

Set to true from a script to (re)start the clip; the backend clears it.

cone_angle: f32

Opening angle in degrees of the sound beam along the object’s forward (-Z) axis. 360 = the same in every direction; a narrow cone is a loudspeaker that is quieter behind and to the sides.

Trait Implementations

impl Clone for AudioSource

fn clone(&self) -> AudioSource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for AudioSource

fn fields(&mut self) -> Vec<Field<'_>>

Mutable field descriptors used by the Inspector and script property serialization.

const REMOVABLE: bool = true

Whether the user may remove it in the inspector.

impl Component for AudioSource

const NAME: &'static str = "AudioSource"

Stable, globally unique name; keep it identical in the host and script library.

const KEY: u64 = _

Storage key derived from [Self::NAME]. Normally should not be overridden.

impl Debug for AudioSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AudioSource

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioSource

where AudioSource: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AudioSource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.