Skip to main content

Module uts

Module uts 

Source
Expand description

Typed UTS (.uts) sound emitter blueprint and conversion helpers. UTS (.uts) typed generic wrapper.

Sound objects are positional ambient audio emitters: environmental hums, randomised crowd chatter, localised loops. Spatial coordinates plus randomised pitch, interval and volume.

§Scope of this slice

  • Typed access for all sound identity/configuration fields.
  • Typed handling for the Sounds list entries.

§Field Layout

UTS root struct
+-- TemplateResRef / Tag / LocName / Comment
+-- Active / Continuous / Looping / Positional / RandomPosition / Random
+-- Elevation / MinDistance / MaxDistance
+-- RandomRangeX / RandomRangeY
+-- Interval / IntervalVrtn / PitchVariation / FixedVariance
+-- Priority / Volume / VolumeVrtn
+-- Hours / Times / PaletteID
+-- Sounds                          (List<Struct>)
    `-- Sound

Structs§

Uts
Typed UTS model built from/to Gff data.
UtsSound
One entry of the Sounds list.

Enums§

UtsError
Errors produced while reading or writing typed UTS data.

Functions§

author_uts
Authors the UTS file the typed view describes, into a writer.
author_uts_to_vec
Authors the UTS file the typed view describes, as bytes.
read_uts
Reads typed UTS data from a reader at the current stream position.
read_uts_from_bytes
Reads typed UTS data directly from bytes.