Struct SoundEvent 

pub struct SoundEvent {
    pub sound_name: Identifier,
    pub fixed_range: Option<Float>,
}

Describes a sound that can be played.

A sound event contains its resource Identifier, followed by a boolean indicating whether a fixed range is present, followed by the optional Float range itself. In memory, the boolean is represented by whether fixed_range is Some:

Identifier + Boolean(has fixed range) + Optional Float

When no fixed range is supplied, playback volume varies with distance according to the sound’s normal behavior.

Examples

use mcproto_types::{Float, Identifier, SoundEvent, TypeCodec};

let sound = SoundEvent::fixed(
    Identifier::new("minecraft:block.note_block.harp")?,
    Float(16.0),
);
let mut encoded = Vec::new();
sound.encode(&mut encoded)?;

let mut input = encoded.as_slice();
assert_eq!(SoundEvent::decode(&mut input)?, sound);
assert!(input.is_empty());

Fields

sound_name: Identifier

The sound’s resource identifier.

fixed_range: Option<Float>

Maximum playback range, or None for distance-dependent volume.

Implementations

impl SoundEvent

pub const fn new(sound_name: Identifier, fixed_range: Option<Float>) -> Self

Creates a sound event with an optional fixed range.

pub const fn variable(sound_name: Identifier) -> Self

Creates a sound event with distance-dependent volume.

pub const fn fixed(sound_name: Identifier, fixed_range: Float) -> Self

Creates a sound event with a fixed maximum range.

pub const fn has_fixed_range(&self) -> bool

Returns whether this sound has a fixed maximum range.

Trait Implementations

impl Clone for SoundEvent

fn clone(&self) -> SoundEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundEvent

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

Formats the value using the given formatter.

impl PartialEq for SoundEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SoundEvent

impl TypeCodec for SoundEvent

fn encode(&self, writer: &mut impl Write) -> Result<(), CodecError>

Encodes this value to the writer.

fn decode(reader: &mut impl Read) -> Result<Self, CodecError>

Decodes this value from the reader.