Skip to main content

Module ute

Module ute 

Source
Expand description

Typed UTE (.ute) encounter blueprint and conversion helpers. UTE (.ute) typed generic wrapper.

UTE resources are GFF-backed encounter templates that define what creatures spawn, how many, and under what conditions.

§Scope

  • Typed access for encounter identity, spawn config, difficulty, and scripts.
  • Typed creature list (CreatureList) with per-entry template, CR, and single-spawn flag.
  • Position, runtime state, area tracking, geometry, spawn points, area list, and spawn list are all fully modeled.

§Field Layout

UTE root struct
+-- TemplateResRef / Tag / LocalizedName / Comment / PaletteID
+-- Active / Reset / ResetTime / Respawns / SpawnOption
+-- MaxCreatures / RecCreatures / PlayerOnly / Faction
+-- DifficultyIndex / Difficulty
+-- XPosition / YPosition / ZPosition
+-- OnEntered / OnExit / OnHeartbeat / OnExhausted / OnUserDefined
+-- NumberSpawned / HeartbeatDay / HeartbeatTime / LastSpawnDay
+-- LastSpawnTime / LastEntered / LastLeft / Started / Exhausted
+-- CurrentSpawns / CustomScriptId
+-- AreaListMaxSize / SpawnPoolActive / AreaPoints
+-- CreatureList[]
|   +-- ResRef / CR / SingleSpawn
+-- Geometry[]
|   +-- X / Y / Z
+-- SpawnPointList[]
|   +-- X / Y / Z / Orientation
+-- AreaList[]
|   +-- AreaObject
+-- SpawnList[]
    +-- SpawnResRef / SpawnCR

Structs§

Ute
Typed UTE model built from/to Gff data.
UteAreaEntry
Typed UTE one entry of AreaList.
UteCreature
Typed UTE one entry of CreatureList.
UteGeometryVertex
Typed UTE one vertex of Geometry.
UteSpawnEntry
Typed UTE one entry of SpawnList.
UteSpawnPoint
Typed UTE one entry of SpawnPointList.

Enums§

UteError
Errors produced while reading or writing typed UTE data.

Functions§

author_ute
Authors the UTE file the typed view describes, into a writer.
author_ute_to_vec
Authors the UTE file the typed view describes, as bytes.
read_ute
Reads typed UTE data from a reader at the current stream position.
read_ute_from_bytes
Reads typed UTE data directly from bytes.