Struct Uts 

pub struct Uts {

    pub template_resref: ResRef,
    pub tag: String,
    pub name: GffLocalizedString,
    pub comment: String,
    pub active: bool,
    pub continuous: bool,
    pub looping: bool,
    pub positional: bool,
    pub random_position: bool,
    pub random_pick: bool,
    pub elevation: f32,
    pub max_distance: f32,
    pub min_distance: f32,
    pub random_range_x: f32,
    pub random_range_y: f32,
    pub interval: u32,
    pub interval_variation: u32,
    pub pitch_variation: f32,
    pub priority: u8,
    pub volume: u8,
    pub volume_variation: u8,
    pub hours: u32,
    pub times: u8,
    pub palette_id: u8,
    pub fixed_variance: f32,
    pub sounds: Vec<UtsSound>,
}

Typed UTS model built from/to Gff data.

Fields

template_resref: ResRef

Sound template resref (TemplateResRef).

tag: String

Sound tag (Tag).

name: GffLocalizedString

Localized sound name (LocName).

comment: String

Toolset comment (Comment).

active: bool

Active flag (Active).

continuous: bool

Continuous flag (Continuous).

looping: bool

Looping flag (Looping).

positional: bool

Positional flag (Positional).

random_position: bool

Random-position flag (RandomPosition).

random_pick: bool

Random-pick flag (Random).

elevation: f32

Elevation (Elevation).

max_distance: f32

Maximum distance (MaxDistance).

min_distance: f32

Minimum distance (MinDistance).

random_range_x: f32

Random range on X axis (RandomRangeX).

random_range_y: f32

Random range on Y axis (RandomRangeY).

interval: u32

Interval (Interval).

interval_variation: u32

Interval variation (IntervalVrtn).

pitch_variation: f32

Pitch variation (PitchVariation).

priority: u8

Priority (Priority).

volume: u8

Volume (Volume).

volume_variation: u8

Volume variation (VolumeVrtn).

hours: u32

Hour restriction (Hours).

times: u8

Time restriction (Times, canonical UInt8).

palette_id: u8

Palette ID (PaletteID).

fixed_variance: f32

Fixed variance (FixedVariance).

sounds: Vec<UtsSound>

Sound entries (Sounds).

Implementations

impl Uts

pub fn new() -> Self

Creates an empty UTS value.

pub fn from_gff(gff: &Gff) -> Result<Self, UtsError>

Builds typed UTS data from a parsed GFF container.

pub fn to_gff(&self) -> Gff

Converts this typed UTS value into a GFF container.

Trait Implementations

impl Clone for Uts

fn clone(&self) -> Uts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Uts

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

Formats the value using the given formatter.

impl Default for Uts

fn default() -> Self

Returns the “default value” for a type.

impl GffSchema for Uts

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

Returns the root field schema for this GFF resource type.

impl PartialEq for Uts

fn eq(&self, other: &Uts) -> 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 Uts