Struct Utt 

pub struct Utt {

    pub tag: String,
    pub name: GffLocalizedString,
    pub faction_id: u32,
    pub cursor_id: u8,
    pub key_name: String,
    pub portrait_id: u16,
    pub portrait: ResRef,
    pub on_heartbeat: ResRef,
    pub on_enter: ResRef,
    pub on_exit: ResRef,
    pub on_user_defined: ResRef,
    pub on_trap_triggered: ResRef,
    pub on_disarm: ResRef,
    pub on_click: ResRef,
    pub trap_type: u8,
    pub trap_one_shot: bool,
    pub trap_disarmable: bool,
    pub trap_detectable: bool,
    pub linked_to: String,
    pub linked_to_flags: u8,
    pub linked_to_module: ResRef,
    pub auto_remove_key: bool,
    pub transition_destination: GffLocalizedString,
    pub type_id: i32,
    pub highlight_height: f32,
    pub loadscreen_id: u16,
    pub set_by_player_party: bool,
    pub geometry: Vec<UttGeometryPoint>,
    pub template_resref: ResRef,
    pub comment: String,
    pub palette_id: u8,
    pub trap_detect_dc: u8,
    pub trap_disarm_dc: u8,
    pub is_trap: bool,
    pub party_required: bool,
}

Typed UTT model built from/to Gff data.

Fields

tag: String

Trigger tag (Tag).

name: GffLocalizedString

Localized trigger name (LocalizedName).

faction_id: u32

Faction identifier (Faction).

cursor_id: u8

Cursor identifier (Cursor).

key_name: String

Key name (KeyName).

portrait_id: u16

Portrait ID (PortraitId). If < 0xFFFE, the engine completely shadows and ignores the string Portrait resref field.

portrait: ResRef

Portrait resref (Portrait). Ignored by the engine if portrait_id is < 0xFFFE.

on_heartbeat: ResRef

On-heartbeat script (ScriptHeartbeat).

on_enter: ResRef

On-enter script (ScriptOnEnter).

on_exit: ResRef

On-exit script (ScriptOnExit).

on_user_defined: ResRef

On-user-defined script (ScriptUserDefine).

on_trap_triggered: ResRef

On-trap-triggered script (OnTrapTriggered).

on_disarm: ResRef

On-disarm script (OnDisarm).

on_click: ResRef

On-click script (OnClick). Only fires for Transition triggers (Type 1). Ignored on Generic triggers.

trap_type: u8

Trap type (TrapType).

trap_one_shot: bool

Trap one-shot flag (TrapOneShot).

trap_disarmable: bool

Trap-disarmable flag (TrapDisarmable).

trap_detectable: bool

Trap-detectable flag (TrapDetectable).

linked_to: String

Linked target tag (LinkedTo).

linked_to_flags: u8

Linked target flags (LinkedToFlags).

linked_to_module: ResRef

Linked target module resref (LinkedToModule).

auto_remove_key: bool

Auto-remove-key flag (AutoRemoveKey).

transition_destination: GffLocalizedString

Localized transition destination text (TransitionDestin).

type_id: i32

Trigger type id (Type). Type 1 (Transition) requires a linked destination. Type 2 (Trap) is required for trap flags to function.

highlight_height: f32

Highlight height (HighlightHeight). Values <= 0.0 are ignored and default to 0.1.

loadscreen_id: u16

Loadscreen ID (LoadScreenID).

set_by_player_party: bool

Set-by-player-party flag (SetByPlayerParty).

geometry: Vec<UttGeometryPoint>

Geometry polygon vertices (Geometry). Engine requires at least 3 vertices to form a valid polygon.

template_resref: ResRef

Trigger template resref (TemplateResRef).

comment: String

Toolset comment (Comment).

palette_id: u8

Palette ID (PaletteID).

trap_detect_dc: u8

Trap detect DC (TrapDetectDC). Ignored by the engine; trap DCs are derived dynamically from traps.2da.

trap_disarm_dc: u8

Trap disarm DC (DisarmDC). Ignored by the engine; trap DCs are derived dynamically from traps.2da.

is_trap: bool

Trap enabled flag (TrapFlag). Engine ignores this if type_id is not 2 (Trap).

party_required: bool

Party-required flag (PartyRequired). Legacy NWN data never read by the K1 engine.

Implementations

impl Utt

pub const SCHEMA: [Field; 42]

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 Utt

pub fn new() -> Self

Creates an empty UTT value.

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

Builds typed UTT data from a parsed GFF container.

Errors

Returns UttError::UnsupportedFileType for a container that is neither UTT nor the generic GFF form.

pub fn to_gff(&self) -> Gff

Converts this typed UTT value into a GFF container.

Trait Implementations

impl Clone for Utt

fn clone(&self) -> Utt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utt

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

Formats the value using the given formatter.

impl Default for Utt

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 Utt

const MAGIC: [u8; 4]

The four bytes a container of this format carries.

type Error = UttError

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 Utt

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 Utt

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