Struct Ute 

pub struct Ute {

    pub template_resref: ResRef,
    pub tag: String,
    pub name: GffLocalizedString,
    pub comment: String,
    pub palette_id: u8,
    pub active: bool,
    pub reset: bool,
    pub reset_time: i32,
    pub respawns: i32,
    pub spawn_option: i32,
    pub max_creatures: i32,
    pub rec_creatures: i32,
    pub player_only: bool,
    pub faction_id: u32,
    pub difficulty_index: i32,
    pub difficulty: i32,
    pub x_position: f32,
    pub y_position: f32,
    pub z_position: f32,
    pub on_entered: ResRef,
    pub on_exit: ResRef,
    pub on_heartbeat: ResRef,
    pub on_exhausted: ResRef,
    pub on_user_defined: ResRef,
    pub number_spawned: i32,
    pub heartbeat_day: u32,
    pub heartbeat_time: u32,
    pub last_spawn_day: u32,
    pub last_spawn_time: u32,
    pub last_entered: u32,
    pub last_left: u32,
    pub started: bool,
    pub exhausted: bool,
    pub current_spawns: i32,
    pub custom_script_id: i32,
    pub area_list_max_size: i32,
    pub spawn_pool_active: f32,
    pub area_points: f32,
    pub creatures: Vec<UteCreature>,
    pub geometry: Vec<UteGeometryVertex>,
    pub spawn_points: Vec<UteSpawnPoint>,
    pub area_list: Vec<UteAreaEntry>,
    pub spawn_list: Vec<UteSpawnEntry>,
}

Typed UTE model built from/to Gff data.

Fields

template_resref: ResRef

Encounter template resref (TemplateResRef).

tag: String

Encounter tag (Tag).

name: GffLocalizedString

Localized encounter name (LocalizedName).

comment: String

Toolset comment (Comment).

palette_id: u8

Palette ID (PaletteID).

active: bool

Whether the encounter is active (Active).

reset: bool

Whether the encounter resets (Reset).

reset_time: i32

Reset time in seconds (ResetTime).

respawns: i32

Number of respawns (Respawns).

spawn_option: i32

Spawn option flag (SpawnOption).

max_creatures: i32

Maximum creatures (MaxCreatures).

rec_creatures: i32

Recommended creatures (RecCreatures).

player_only: bool

Player-only flag (PlayerOnly).

faction_id: u32

Faction identifier (Faction).

difficulty_index: i32

Difficulty index (DifficultyIndex).

difficulty: i32

Difficulty value (Difficulty).

x_position: f32

X position in area (XPosition).

y_position: f32

Y position in area (YPosition).

z_position: f32

Z position in area (ZPosition).

on_entered: ResRef

On-entered script (OnEntered).

on_exit: ResRef

On-exit script (OnExit).

on_heartbeat: ResRef

On-heartbeat script (OnHeartbeat).

on_exhausted: ResRef

On-exhausted script (OnExhausted).

on_user_defined: ResRef

On-user-defined script (OnUserDefined).

number_spawned: i32

Number of creatures spawned so far (NumberSpawned).

heartbeat_day: u32

Heartbeat day counter (HeartbeatDay).

heartbeat_time: u32

Heartbeat time counter (HeartbeatTime).

last_spawn_day: u32

Day of last spawn (LastSpawnDay).

last_spawn_time: u32

Time of last spawn (LastSpawnTime).

last_entered: u32

Last-entered object ID (LastEntered).

last_left: u32

Last-left object ID (LastLeft).

started: bool

Whether the encounter has started (Started).

exhausted: bool

Whether the encounter is exhausted (Exhausted).

current_spawns: i32

Current live spawn count (CurrentSpawns).

custom_script_id: i32

Custom script identifier (CustomScriptId).

area_list_max_size: i32

Maximum size of the area list (AreaListMaxSize).

spawn_pool_active: f32

Active spawn pool value (SpawnPoolActive).

area_points: f32

Area points value (AreaPoints).

creatures: Vec<UteCreature>

Creatures that can spawn in this encounter (CreatureList).

geometry: Vec<UteGeometryVertex>

Boundary geometry vertices (Geometry).

spawn_points: Vec<UteSpawnPoint>

Spawn point positions (SpawnPointList).

area_list: Vec<UteAreaEntry>

Area tracking entries (AreaList).

spawn_list: Vec<UteSpawnEntry>

Spawn resource entries (SpawnList).

Implementations

impl Ute

pub fn new() -> Self

Creates an empty UTE value.

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

Builds typed UTE data from a parsed GFF container.

pub fn to_gff(&self) -> Gff

Converts this typed UTE value into a GFF container.

All fields are written from scratch - no source template is retained.

Trait Implementations

impl Clone for Ute

fn clone(&self) -> Ute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ute

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

Formats the value using the given formatter.

impl Default for Ute

fn default() -> Self

Returns the “default value” for a type.

impl GffSchema for Ute

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

Returns the root field schema for this GFF resource type.

impl PartialEq for Ute

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