Struct SoundPlay 

#[non_exhaustive]
pub struct SoundPlay {
    pub identifier: String,
    pub source: SoundSource,
    pub volume: f32,
    pub pitch: f32,
    pub position: [f64; 3],
    pub looping: bool,
    pub delay: i32,
    pub attenuation: SoundAttenuation,
    pub relative: bool,
}

A sound about to play, for play_sound (SoundInstance’s own settings: vanilla’s getIdentifier, getSource, getVolume, getPitch, getX/Y/Z, isLooping, getDelay, getAttenuation and isRelative).

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.

identifier: String

The sound event (minecraft:entity.pig.ambient).

source: SoundSource

The mixer group it plays on.

volume: f32

Its own volume, before the source’s and the master’s.

pitch: f32

Its pitch, 1.0 unchanged.

position: [f64; 3]

Where it plays, in blocks; meaningless when relative.

looping: bool

It restarts when it ends.

delay: i32

Ticks between a looping sound’s repeats (SoundInstance.getDelay): 0 loops it seamlessly, more plays it again that many ticks after it ends.

attenuation: SoundAttenuation

How it fades with distance.

relative: bool

It plays at the listener, wherever they move.

Implementations

impl SoundPlay

pub fn ui(identifier: &str) -> SoundPlay

Sound event identifier at the listener, not fading with distance, on the interface source at volume and pitch 1 (SimpleSoundInstance.forUI).

pub fn at( identifier: &str, source: SoundSource, position: [f64; 3], ) -> SoundPlay

Sound event identifier at position on source, fading with distance, at volume and pitch 1 (SimpleSoundInstance’s positioned constructor).

pub fn with_volume(self, volume: f32) -> SoundPlay

The same sound at volume.

pub fn with_pitch(self, pitch: f32) -> SoundPlay

The same sound at pitch.

pub fn looping(self, delay: i32) -> SoundPlay

The same sound looping, delay ticks between its repeats.

Trait Implementations

impl Clone for SoundPlay

fn clone(&self) -> SoundPlay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundPlay

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

Formats the value using the given formatter.

impl From<SoundPlay> for SoundPlay

fn from(v: SoundPlay) -> SoundPlay

Converts to this type from the input type.

impl PartialEq for SoundPlay

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SoundPlay

impl Wire for SoundPlay

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<SoundPlay, WireError>

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