Struct SavedSound 

pub struct SavedSound {

    pub common: GitSoundCommon,
    pub active: bool,
    pub commandable: bool,
    pub continuous: bool,
    pub fixed_variance: f32,
    pub hours: u32,
    pub interval: u32,
    pub interval_variation: u32,
    pub looping: bool,
    pub max_distance: f32,
    pub min_distance: f32,
    pub pitch_variation: f32,
    pub positional: bool,
    pub random: bool,
    pub random_position: bool,
    pub random_range_x: f32,
    pub random_range_y: f32,
    pub sounds: Vec<UtsSound>,
    pub tag: String,
    pub times: u8,
    pub volume: u8,
    pub volume_variation: u8,
}

A sound emitter as stored inside a save game’s module GIT.

Fields

common: GitSoundCommon

The block both forms carry, which the list declares as its element.

No #[gff]: the arm contributes its parts to the split, and the element is this block, so declaring it here too would make one label two declarations. The arm’s own codec reads and writes it.

active: bool

Currently emitting (Active).

commandable: bool

Accepts scripted commands (Commandable), written and never read back.

One of the base-object labels CSWSObject::LoadObjectState reads, and LoadSounds is the only dispatcher that never calls it. So a sound is the one owner where the save writer emits this and no load path on either branch looks for it.

continuous: bool

Plays without gaps between entries (Continuous).

fixed_variance: f32

Fixed pitch variance (FixedVariance).

hours: u32

Hour mask the emitter is awake for (Hours).

interval: u32

Gap between plays, in milliseconds (Interval).

interval_variation: u32

Random variance added to the gap (IntervalVrtn).

looping: bool

Restarts the playlist when it ends (Looping).

max_distance: f32

Distance at which the sound is inaudible (MaxDistance).

min_distance: f32

Distance at which attenuation starts (MinDistance).

pitch_variation: f32

Random pitch variance (PitchVariation).

positional: bool

Attenuates with distance (Positional).

random: bool

Shuffles the playlist (Random).

random_position: bool

Moves the emitter between plays (RandomPosition).

random_range_x: f32

Random reposition range along X (RandomRangeX).

random_range_y: f32

Random reposition range along Y (RandomRangeY).

sounds: Vec<UtsSound>

Playlist entries (Sounds). The element shape matches a .uts entry, so this reuses UtsSound. Every element is struct id 0 rather than its index.

tag: String

Object tag (Tag).

times: u8

Repeat count (Times).

volume: u8

Volume (Volume).

volume_variation: u8

Random volume variance (VolumeVrtn).

Implementations

impl SavedSound

pub const SCHEMA: [Field; 21]

This view’s schema, one entry per declared field.

pub const PARTS: &'static [&'static [Field]]

This type’s schema in parts, which is what a container holding it references.

Own fields first, then one part per flattened child in the order they are declared.

pub fn read_declared(root: &GffStruct) -> Self

Reads every declared field off root.

Absent fields take the entry’s own answer, so a fallback is derived from the declaration rather than restated beside it.

A field declaring a hand-written read is left at that answer for the view to overwrite.

pub fn write_declared(&self, root: &mut GffStruct)

Writes every declared field onto root, leaving out the ones their entry says the engine’s own writer leaves out.

A field declaring a hand-written write is not touched here.

impl SavedSound

pub fn read_element(structure: &GffStruct) -> Self

Reads one element, with the block the list declares as its element.

pub fn write_element(&self, structure: &mut GffStruct)

Writes one element, the common block included.

Trait Implementations

impl Clone for SavedSound

fn clone(&self) -> SavedSound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SavedSound

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

Formats the value using the given formatter.

impl Default for SavedSound

fn default() -> Self

What a file omitting every label loads to, which is what makes an authored file land in a known state rather than at zero.

impl GitElement for SavedSound

fn read(structure: &GffStruct) -> Self

Reads one element.

fn write(&self, id: i32) -> GffStruct

Writes one element into a struct carrying the list’s own id.

impl HasSchema for SavedSound

fn schema() -> &'static [Field]

The root field schema for this resource type.

fn parts() -> &'static [&'static [Field]]

The same schema in parts, own fields first.

impl PartialEq for SavedSound

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SavedSound