Struct Sound

pub struct Sound {
    pub id: SoundID,
    pub play_delay: i16,
    pub cache_time: i32,
    pub items: Vec<SoundItem>,
}

A “conceptual” sound, consisting of one or a group of sound files.

Items can be picked depending on the player’s civilization, and depending on the probabilities for each file.

Fields

id: SoundID

Unique ID for this sound.

play_delay: i16

TODO document.

cache_time: i32

TODO document.

items: Vec<SoundItem>

List of sound files in this sound.

Implementations

impl Sound

pub fn read_from<R: Read>(input: &mut R, version: FileVersion) -> Result<Self>

Read this sound from an input stream.

pub fn write_to<W: Write>( &self, output: &mut W, version: FileVersion, ) -> Result<()>

Write this sound to an input stream.

pub fn len(&self) -> usize

Get the number of sound files that are part of this “conceptual” sound.

pub fn is_empty(&self) -> bool

Returns true if there are no sound files.

Trait Implementations

impl Clone for Sound

fn clone(&self) -> Sound

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sound

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

Formats the value using the given formatter.

impl Default for Sound

fn default() -> Sound

Returns the “default value” for a type.