Struct InstrumentValue 

pub struct InstrumentValue {
    sound_event: SoundEventHolder,
    use_duration: f32,
    range: f32,
    description: TextComponent,
}

A complete instrument definition, either registered or stored inline.

The direct stream codec carries raw floats, but Steel validates them against the persistent codec before constructing this value so item stacks cannot contain an instrument that later fails to save.

Fields

sound_event: SoundEventHolder

use_duration: f32

range: f32

description: TextComponent

Implementations

impl InstrumentValue

pub fn new( sound_event: SoundEventHolder, use_duration: f32, range: f32, description: TextComponent, ) -> Result<Self, InvalidInstrumentValue>

pub(crate) const fn from_validated_parts( sound_event: SoundEventHolder, use_duration: f32, range: f32, description: TextComponent, ) -> Self

pub const fn sound_event(&self) -> &SoundEventHolder

pub const fn use_duration(&self) -> f32

pub const fn range(&self) -> f32

pub const fn description(&self) -> &TextComponent

fn to_nbt_tag_ref(&self) -> NbtTag

Trait Implementations

impl Clone for InstrumentValue

fn clone(&self) -> InstrumentValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstrumentValue

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

Formats the value using the given formatter.

impl FromNbtTag for InstrumentValue

fn from_nbt_tag(tag: NbtTag<'_, '_>) -> Option<Self>

fn from_optional_nbt_tag( tag: Option<NbtTag<'_, '_>>, ) -> Result<Option<Self>, DeserializeError>

impl HashComponent for InstrumentValue

fn hash_component(&self, hasher: &mut ComponentHasher)

Hashes this value into the given hasher.

fn compute_hash(&self) -> i32

Computes the hash of this value.

impl PartialEq for InstrumentValue

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

Equality operator ==.

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

Inequality operator !=.

impl ReadFrom for InstrumentValue

fn read(data: &mut Cursor<&[u8]>) -> IoResult<Self>

Reads data from a cursor.

impl ToNbtTag for InstrumentValue

fn to_nbt_tag(self) -> NbtTag

fn to_optional_nbt_tag(self) -> Option<NbtTag>

impl WriteTo for InstrumentValue

fn write(&self, writer: &mut impl Write) -> IoResult<()>

Writes data to a writer.