Struct Utm 

pub struct Utm {
    pub resref: ResRef,
    pub tag: String,
    pub name: GffLocalizedString,
    pub mark_up: i32,
    pub mark_down: i32,
    pub on_open_store: ResRef,
    pub comment: String,
    pub id: u8,
    pub buy_sell_flag: u8,
    pub inventory: Vec<UtmInventoryItem>,
}

Typed UTM model built from/to Gff data.

Fields

resref: ResRef

Merchant template resref (ResRef).

tag: String

Merchant tag (Tag).

name: GffLocalizedString

Localized merchant name (LocName).

mark_up: i32

Markup percentage (MarkUp).

mark_down: i32

Markdown percentage (MarkDown).

on_open_store: ResRef

On-open-store script (OnOpenStore).

comment: String

Toolset comment (Comment).

id: u8

Deprecated ID field (ID).

buy_sell_flag: u8

What the store will trade (BuySellFlag), as the byte the file holds.

The whole byte, rather than a member per bit. Bit 0 is buy and bit 1 is sell; the rest are unaccounted for and are preserved by being here at all. Self::can_buy and Self::can_sell read the two that mean something, which keeps the declared field the label’s actual value the way every other entry in the tree is.

inventory: Vec<UtmInventoryItem>

Inventory entries (ItemList).

Implementations

impl Utm

pub const SCHEMA: [Field; 10]

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.

pub fn read_element(structure: &GffStruct) -> Self

Reads one element of a list of this type.

pub fn write_element(&self, structure: &mut GffStruct)

Writes one element of a list of this type.

impl Utm

pub fn new() -> Self

Creates an empty UTM value.

pub fn can_buy(&self) -> bool

Whether the store buys from the player.

pub fn can_sell(&self) -> bool

Whether the store sells to the player.

pub fn unknown_flag_bits(&self) -> u8

The bits of BuySellFlag nothing is known to read.

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

Builds typed UTM data from a parsed GFF container.

Errors

Returns UtmError::UnsupportedFileType for a container that is neither UTM nor the generic GFF form.

pub fn to_gff(&self) -> Gff

Converts this typed UTM value into a GFF container.

Trait Implementations

impl Clone for Utm

fn clone(&self) -> Utm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utm

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

Formats the value using the given formatter.

impl Default for Utm

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 Utm

const MAGIC: [u8; 4]

The four bytes a container of this format carries.

type Error = UtmError

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 Utm

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 Utm

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