Struct SoundCue 

#[non_exhaustive]
pub struct SoundCue {
    pub files: Vec<String>,
    pub volume: u8,
    pub credit: CreditRef,
    pub looped: bool,
}

A sound effect: one of its files plays each time. Build it with SoundCue::new (ADR-0039).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

files: Vec<String>

The variants, relative to base/audio/; one is picked at random each time the cue plays. At least one.

volume: u8

Volume in percent (0–100).

credit: CreditRef

Who made it.

looped: bool

Whether it loops until it is stopped (false, the file’s default: it plays once). A looped cue is started with a handle (AudioQueue::start_sound in shuyi-ui), which stops it.

Implementations

impl SoundCue

pub const fn new(files: Vec<String>, volume: u8, credit: CreditRef) -> Self

The sound of files (one picked each time), at volume percent, made by credit, played once.

pub const fn with_looped(self, looped: bool) -> Self

The same cue, looped until it is stopped or not.

Trait Implementations

impl Clone for SoundCue

fn clone(&self) -> SoundCue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundCue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SoundCue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SoundCue

impl PartialEq for SoundCue

fn eq(&self, other: &SoundCue) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SoundCue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SoundCue