Struct SoundRef 

pub struct SoundRef { /* private fields */ }

A sound a client mod started with play_local_sound, to follow and control: state, stop and fade. Each handle names one play and is never reused. Once the sound has ended, been stopped or been cleared (leaving or changing levels stops every sound), the handle is stale: it reads SoundState::Stopped and its writes do nothing. It stays valid across a change of output device, which keeps the sounds playing.

Dropping or overwriting the handle doesn’t stop the sound: keep a looping sound’s handle while it plays (stop it before starting another in its place), or nothing can stop it until the player leaves the level.

Implementations

impl SoundRef

pub fn state(self, host: &dyn ClientHost) -> Option<SoundState>

Side: client. Where a sound play_local_sound started is: waiting to start, playing, or over.

pub fn stop(self, host: &dyn ClientHost) -> bool

Side: client. Stops the sound for good: a waiting one never starts and a looping one never repeats.

pub fn fade(self, host: &dyn ClientHost, volume: f32, ticks: u32) -> bool

Side: client. Fades the sound’s volume to a target over some unpaused ticks; a fade to 0 stops it at the end. While the game is paused the fade waits, and an interface or music sound keeps playing.

Trait Implementations

impl Clone for SoundRef

fn clone(&self) -> SoundRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SoundRef

impl Debug for SoundRef

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

Formats the value using the given formatter.

impl Eq for SoundRef

impl Hash for SoundRef

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SoundRef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SoundRef

impl Wire for SoundRef

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<SoundRef, WireError>

Decodes one value, leaving any following bytes for the caller.