Struct SoundGroup 

pub struct SoundGroup {
    pub id: String,
    pub break_sound: String,
    pub step: String,
    pub place: String,
    pub hit: String,
    pub fall: String,
    pub volume: f32,
    pub pitch: f32,
}

What a block sounds like: the sound events it plays when broken, stepped on, placed, hit while mining and fallen on. The game’s groups are built in (SoundGroup::built_in); a mod registers its own (Registry::register_sound_group, or a .ydef of kind sound_group) and names it in BlockDef::sound.

Fields

id: String

break_sound: String

Sound event ids (minecraft:block.stone.break, mymod:crystal.break).

step: String

place: String

hit: String

fall: String

volume: f32

pitch: f32

Implementations

impl SoundGroup

pub fn new(id: impl Into<String>) -> SoundGroup

mymod:crystal, its sounds mymod:crystal.break, .step, .place, .hit, .fall; volume and pitch 1.

pub fn sounds( self, break_sound: &str, step: &str, place: &str, hit: &str, fall: &str, ) -> SoundGroup

The five sound events: break, step, place, hit, fall.

pub fn volume(self, volume: f32) -> SoundGroup

pub fn pitch(self, pitch: f32) -> SoundGroup

pub fn built_ins() -> &'static [SoundGroup]

The game’s groups (minecraft:stone, minecraft:amethyst…, from Minecraft’s SoundType), as data.

pub fn built_in(name: &str) -> Option<&'static SoundGroup>

One of the game’s groups, by short name or id (stone = minecraft:stone).

Trait Implementations

impl Clone for SoundGroup

fn clone(&self) -> SoundGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundGroup

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

Formats the value using the given formatter.

impl Fields for SoundGroup

const FIELDS: &'static [(&'static str, &'static str)]

impl PartialEq for SoundGroup

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for SoundGroup

fn encode(&self, __yog_w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn pack(&self, __yog_p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(__yog_u: &mut Unpacker<'_>) -> Option<SoundGroup>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<SoundGroup>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn decode(d: &mut Decoder<'_>) -> Option<Self>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.

impl StructuralPartialEq for SoundGroup