Expand description
Typed UTE (.ute) model 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 / SpawnCRStructs§
- Ute
- Typed UTE model built from/to
Gffdata. - UteArea
Entry - An entry in the encounter’s area tracking list (
AreaListlist). - UteCreature
- A single entry in the encounter’s creature table.
- UteGeometry
Vertex - A single vertex in the encounter’s boundary geometry (
Geometrylist). - UteSpawn
Entry - An entry in the encounter’s spawn resource list (
SpawnListlist). - UteSpawn
Point - A spawn point in the encounter (
SpawnPointListlist).
Enums§
- UteError
- Errors produced while reading or writing typed UTE data.
Functions§
- 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.
- write_
ute - Writes typed UTE data to an output writer.
- write_
ute_ to_ vec - Serializes typed UTE data into a byte vector.