Struct AudioEmitter 

pub struct AudioEmitter {
    pub clip: Option<AudioClipHandle>,
    pub position: [f32; 3],
    pub volume: f32,
    pub looping: bool,
    pub prop: Option<AssetId>,
    pub min_distance: f32,
    pub max_distance: f32,
    pub rolloff: Rolloff,
    pub bus: Option<AudioBus>,
}

A point source of sound in the world.

Plays its clip (an AudioClip reference) from position, attenuated and panned relative to the camera. When prop names a Prop, the emitter tracks that prop’s position every frame, so the sound follows a moving object.

The sound is at full volume inside min_distance, fades according to rolloff between min_distance and max_distance, and is inaudible beyond max_distance.

AudioEmitter {
    position: [6.0, 4.0, -6.0],
    ..Default::default()
};

Fields

clip: Option<AudioClipHandle>

The AudioClip this emitter plays.

position: [f32; 3]

World-space position of the sound source.

volume: f32

Linear gain multiplier applied to the clip.

looping: bool

Whether the clip restarts when it ends.

prop: Option<AssetId>

Optional Prop whose position the emitter tracks each frame.

min_distance: f32

Distance from the listener at which the sound plays at full volume.

max_distance: f32

Distance from the listener beyond which the sound is inaudible. Must exceed min_distance.

rolloff: Rolloff

How volume falls between min_distance and max_distance.

bus: Option<AudioBus>

Mix bus the emitter routes through. Defaults to sfx.

Trait Implementations

impl Clone for AudioEmitter

fn clone(&self) -> AudioEmitter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for AudioEmitter

const NAME: &'static str = "AudioEmitter"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<AudioEmitter, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

impl ComponentSlot for AudioEmitter

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.

fn slot(s: &ComponentStorage) -> &Column<AudioEmitter>

Borrow this type’s column out of the storage.

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<AudioEmitter>

Mutably borrow this type’s column out of the storage.

impl Debug for AudioEmitter

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

Formats the value using the given formatter.

impl Default for AudioEmitter

fn default() -> AudioEmitter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioEmitter

where AudioEmitter: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<AudioEmitter, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AudioEmitter> for ComponentAsset

fn from(c: AudioEmitter) -> ComponentAsset

Converts to this type from the input type.

impl RuntimeComponent for AudioEmitter

impl Serialize for AudioEmitter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.