Struct SavedSound 

pub struct SavedSound {

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

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

Fields

tag: String

Object tag (Tag).

object_id: ObjectId

Runtime object id (ObjectId).

commandable: bool

Accepts scripted commands (Commandable).

active: bool

Currently emitting (Active).

looping: bool

Restarts the playlist when it ends (Looping).

continuous: bool

Plays without gaps between entries (Continuous).

random: bool

Shuffles the playlist (Random).

random_position: bool

Moves the emitter between plays (RandomPosition).

positional: bool

Attenuates with distance (Positional).

sounds: Vec<UtsSound>

Playlist entries (Sounds). The element shape matches a .uts entry, so this reuses UtsSound.

times: u8

Repeat count (Times).

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).

generated_type: u32

Playback source kind (GeneratedType).

volume: u8

Volume (Volume).

volume_variation: u8

Random volume variance (VolumeVrtn).

pitch_variation: f32

Random pitch variance (PitchVariation).

fixed_variance: f32

Fixed pitch variance (FixedVariance).

min_distance: f32

Distance at which attenuation starts (MinDistance).

max_distance: f32

Distance at which the sound is inaudible (MaxDistance).

random_range_x: f32

Random reposition range along X (RandomRangeX).

random_range_y: f32

Random reposition range along Y (RandomRangeY).

x_position: f32

World X position (XPosition).

y_position: f32

World Y position (YPosition).

z_position: f32

World Z position (ZPosition).

Implementations

impl SavedSound

pub fn new() -> Self

Creates an empty saved sound.

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

Reads one saved SoundList element.

pub fn to_struct(&self, index: usize) -> GffStruct

Writes this sound back into a SoundList element.

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() -> SavedSound

Returns the “default value” for a type.

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