Struct AudioCue 

pub struct AudioCue {
    pub asset_id: AssetId,
    pub screen: Option<AssetId>,
    pub clip: Option<AudioClipHandle>,
    pub kind: CueKind,
    pub volume: f32,
    pub bus: Option<AudioBus>,
    pub priority: i32,
}

Plays audio when a Screen is shown.

A cue links a Screen to an AudioClip: whenever UI navigation makes the screen active (a screen:show or screen:toggle action, a KeyBinding, dismissing an overlay back to it, or being the world’s initial screen), the clip plays. Cues play flat on the main mix with no 3D position; use an AudioEmitter for positional sound.

The kind decides the playback behavior:

• music: loops until replaced. Showing a screen whose music cue is already playing leaves the track running, so navigating between screens that share a cue is seamless. A screen with a different music cue replaces the track; a screen with no music cue leaves the current music playing.
• sound: a one-shot effect, played every time the screen is shown.

Fields

asset_id: AssetId

Asset identity; injected via inject_name. Not part of args.

screen: Option<AssetId>

The Screen whose activation triggers this cue.

clip: Option<AudioClipHandle>

The AudioClip to play.

kind: CueKind

Playback behavior: a looping music track or a one-shot sound.

volume: f32

Linear gain applied to the clip (1.0 leaves it unchanged).

bus: Option<AudioBus>

Mix bus the cue routes through. Defaults to music for a music cue and sfx for a sound cue; set voice for dialogue.

priority: i32

Voice priority for a sound cue. When all voice slots are busy, a new sound silences the oldest lowest-priority voice; a sound outranked by everything playing is skipped. Higher wins; the default is 0.

Trait Implementations

impl Clone for AudioCue

fn clone(&self) -> AudioCue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for AudioCue

const NAME: &'static str = "AudioCue"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<AudioCue, 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 AudioCue

const DISCRIMINANT: u8

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

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

Borrow this type’s column out of the storage.

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

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

impl Debug for AudioCue

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

Formats the value using the given formatter.

impl Default for AudioCue

fn default() -> AudioCue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioCue

where AudioCue: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AudioCue> for ComponentAsset

fn from(c: AudioCue) -> ComponentAsset

Converts to this type from the input type.

impl RuntimeComponent for AudioCue

impl Serialize for AudioCue

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.