Struct Uti 

pub struct Uti {

    pub template_resref: ResRef,
    pub base_item: i32,
    pub name: GffLocalizedString,
    pub description_unidentified: GffLocalizedString,
    pub description_identified: GffLocalizedString,
    pub tag: String,
    pub charges: u8,
    pub cost: u32,
    pub stack_size: u16,
    pub plot: bool,
    pub add_cost: u32,
    pub palette_id: u8,
    pub comment: String,
    pub body_variation: u8,
    pub texture_variation: u8,
    pub upgrade_level: u8,
    pub stolen: bool,
    pub identified: bool,
    pub droppable: bool,
    pub pickpocketable: bool,
    pub non_equippable: bool,
    pub new_item: bool,
    pub deleting: bool,
    pub upgrades: u32,
    pub properties: Vec<UtiProperty>,
    pub max_charges: u8,
    pub model_variation: u8,
}

Typed UTI model built from/to Gff data.

ModelPart1 is declared without a member: it is the older spelling ModelVariation falls back to, so the value lands in that field and the label still has to be recognised.

Fields

template_resref: ResRef

TemplateResRef. Never read by the K1 engine.

base_item: i32

Base item identifier (BaseItem).

name: GffLocalizedString

Localized item name (LocalizedName).

description_unidentified: GffLocalizedString

Localized description shown before identification (Description).

description_identified: GffLocalizedString

Localized description shown when identified (DescIdentified).

tag: String

Item tag (Tag).

charges: u8

Charges (Charges).

cost: u32

Item cost (Cost). Ignored by the engine, which computes item cost dynamically.

stack_size: u16

Maximum stack size (StackSize).

plot: bool

Plot item flag (Plot).

add_cost: u32

Additional cost modifier (AddCost).

palette_id: u8

Palette identifier (PaletteID). Never read by the K1 engine.

comment: String

Toolset comment (Comment). Never read by the K1 engine.

body_variation: u8

Body variation (BodyVariation). Ignored by the engine, which reads from baseitems.2da instead.

texture_variation: u8

Texture variation (TextureVar). Only evaluated when the item’s 2DA model_type is exactly 1.

upgrade_level: u8

Upgrade level (UpgradeLevel). Never read by the K1 engine.

stolen: bool

Stolen flag (Stolen).

identified: bool

Identified flag (Identified). SaveItem hardcodes this to true, so any other value is dead once a save is written.

droppable: bool

Droppable flag (Dropable). Sets bit 3 of the item’s internal memory flags.

pickpocketable: bool

Pickpocketable flag (Pickpocketable). Sets bit 4 of the item’s internal memory flags.

non_equippable: bool

Non-equippable flag (NonEquippable).

new_item: bool

New-item flag (NewItem).

deleting: bool

Deleting flag (DELETING).

upgrades: u32

Upgrade bitfield (Upgrades).

properties: Vec<UtiProperty>

Item property entries (PropertiesList).

max_charges: u8

Maximum charges (MaxCharges).

Absent, this is whatever Charges resolved to rather than a literal, so from_gff reads it and the declaration only records the schema.

model_variation: u8

Model variation (ModelVariation).

Absent entirely, the engine falls back to the older ModelPart1 label before applying the same zero-check, so an ancient file carrying only ModelPart1 still gets a model. That chain is why from_gff reads it.

Implementations

impl Uti

pub const SCHEMA: [Field; 28]

This view’s schema, one entry per declared field.

pub const PARTS: &'static [&'static [Field]]

This type’s schema in parts, which is what a container holding it references.

Own fields first, then one part per flattened child in the order they are declared.

pub fn read_declared(root: &GffStruct) -> Self

Reads every declared field off root.

Absent fields take the entry’s own answer, so a fallback is derived from the declaration rather than restated beside it.

A field declaring a hand-written read is left at that answer for the view to overwrite.

pub fn write_declared(&self, root: &mut GffStruct)

Writes every declared field onto root, leaving out the ones their entry says the engine’s own writer leaves out.

A field declaring a hand-written write is not touched here.

impl Uti

pub fn new() -> Self

Creates an empty UTI value.

pub fn is_armor(&self) -> bool

Returns true when this item’s BaseItem belongs to the armor family.

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

Builds typed UTI data from a parsed GFF container.

Errors

Returns UtiError::UnsupportedFileType for a container that is neither UTI nor the generic GFF form.

pub fn to_gff(&self) -> Gff

Converts this typed UTI value into a GFF container.

Trait Implementations

impl Clone for Uti

fn clone(&self) -> Uti

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Uti

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

Formats the value using the given formatter.

impl Default for Uti

fn default() -> Self

What a file omitting every label loads to, which is what makes an authored file land in a known state rather than at zero.

impl FromGff for Uti

const MAGIC: [u8; 4]

The four bytes a container of this format carries.

type Error = UtiError

What reading this view out of a tree can fail with.

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

Reads the view. Anything the view does not model stays in gff.

impl HasSchema for Uti

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

The root field schema for this resource type.

fn parts() -> &'static [&'static [Field]]

The same schema in parts, own fields first.

impl PartialEq for Uti

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