Struct Utp 

pub struct Utp {

    pub template_resref: ResRef,
    pub tag: String,
    pub name: GffLocalizedString,
    pub description: GffLocalizedString,
    pub comment: String,
    pub conversation: ResRef,
    pub faction_id: u32,
    pub appearance_id: u32,
    pub animation_state: u8,
    pub animation: i32,
    pub open: bool,
    pub auto_remove_key: bool,
    pub key_name: String,
    pub key_required: bool,
    pub lockable: bool,
    pub locked: bool,
    pub open_lock_dc: u8,
    pub close_lock_dc: u8,
    pub open_lock_diff: u8,
    pub open_lock_diff_mod: i8,
    pub current_hp: i16,
    pub maximum_hp: i16,
    pub hardness: u8,
    pub fortitude: u8,
    pub reflex: u8,
    pub will: u8,
    pub plot: bool,
    pub invulnerable: bool,
    pub min1_hp: bool,
    pub not_blastable: bool,
    pub is_static: bool,
    pub useable: bool,
    pub party_interact: bool,
    pub has_inventory: bool,
    pub die_when_empty: bool,
    pub ground_pile: bool,
    pub light_state: bool,
    pub interruptable: bool,
    pub portrait_id: u16,
    pub portrait: ResRef,
    pub palette_id: u8,
    pub bodybag_id: u8,
    pub type_id: u8,
    pub is_body_bag: bool,
    pub is_corpse: bool,
    pub trap_detectable: bool,
    pub trap_detect_dc: u8,
    pub trap_disarmable: bool,
    pub trap_disarm_dc: u8,
    pub trap_flag: u8,
    pub trap_one_shot: bool,
    pub trap_type: u8,
    pub on_closed: ResRef,
    pub on_damaged: ResRef,
    pub on_death: ResRef,
    pub on_disarm: ResRef,
    pub on_heartbeat: ResRef,
    pub on_inventory: ResRef,
    pub on_lock: ResRef,
    pub on_melee_attacked: ResRef,
    pub on_open: ResRef,
    pub on_spell_cast_at: ResRef,
    pub on_unlock: ResRef,
    pub on_used: ResRef,
    pub on_user_defined: ResRef,
    pub on_dialog: ResRef,
    pub on_end_dialogue: ResRef,
    pub on_trap_triggered: ResRef,
    pub on_fail_to_open: ResRef,
    pub inventory: Vec<UtpInventoryItem>,
}

Typed UTP model built from/to Gff data.

Fields

template_resref: ResRef

Placeable template resref (TemplateResRef).

tag: String

Placeable tag (Tag).

name: GffLocalizedString

Localized placeable name (LocName).

description: GffLocalizedString

Localized description (Description).

comment: String

Toolset comment (Comment).

conversation: ResRef

Conversation resref (Conversation).

faction_id: u32

Faction identifier (Faction).

appearance_id: u32

Appearance identifier (Appearance).

animation_state: u8

Animation state (AnimationState).

animation: i32

Animation id (Animation).

open: bool

Open-state flag (Open).

auto_remove_key: bool

Auto-remove-key flag (AutoRemoveKey).

key_name: String

Key name (KeyName).

key_required: bool

Key-required flag (KeyRequired).

lockable: bool

Lockable flag (Lockable).

locked: bool

Locked flag (Locked).

open_lock_dc: u8

Open lock DC (OpenLockDC).

close_lock_dc: u8

Close lock DC (CloseLockDC).

open_lock_diff: u8

Open-lock diff (OpenLockDiff, K2-oriented field).

open_lock_diff_mod: i8

Open-lock diff modifier (OpenLockDiffMod, K2-oriented field).

current_hp: i16

Current hit points (CurrentHP).

maximum_hp: i16

Maximum hit points (HP).

hardness: u8

Hardness (Hardness).

fortitude: u8

Fortitude save (Fort).

reflex: u8

Reflex save (Ref).

will: u8

Will save (Will).

plot: bool

Plot flag (Plot).

invulnerable: bool

Invulnerable flag (Invulnerable).

min1_hp: bool

Min-1HP flag (Min1HP).

not_blastable: bool

Not-blastable flag (NotBlastable, K2-oriented field).

is_static: bool

Static flag (Static).

useable: bool

Useable flag (Useable).

party_interact: bool

Party-interact flag (PartyInteract).

has_inventory: bool

Has-inventory flag (HasInventory).

die_when_empty: bool

Die-when-empty flag (DieWhenEmpty).

ground_pile: bool

Ground-pile flag (GroundPile).

light_state: bool

Light-state flag (LightState).

interruptable: bool

Interruptable flag (Interruptable).

portrait_id: u16

Portrait ID (PortraitId).

portrait: ResRef

Portrait resref (Portrait).

palette_id: u8

Palette ID (PaletteID).

bodybag_id: u8

Body-bag type (BodyBag).

type_id: u8

Type ID (Type).

is_body_bag: bool

Is-body-bag flag (IsBodyBag).

is_corpse: bool

Is-corpse flag (IsCorpse).

trap_detectable: bool

Trap-detectable flag (TrapDetectable).

trap_detect_dc: u8

Trap detect DC (TrapDetectDC).

trap_disarmable: bool

Trap-disarmable flag (TrapDisarmable).

trap_disarm_dc: u8

Trap disarm DC (DisarmDC).

trap_flag: u8

Trap flag (TrapFlag).

trap_one_shot: bool

Trap one-shot flag (TrapOneShot).

trap_type: u8

Trap type (TrapType).

on_closed: ResRef

On-closed script (OnClosed).

on_damaged: ResRef

On-damaged script (OnDamaged).

on_death: ResRef

On-death script (OnDeath).

on_disarm: ResRef

On-disarm script (OnDisarm).

on_heartbeat: ResRef

On-heartbeat script (OnHeartbeat).

on_inventory: ResRef

On-inventory-disturbed script (OnInvDisturbed).

on_lock: ResRef

On-lock script (OnLock).

on_melee_attacked: ResRef

On-melee-attacked script (OnMeleeAttacked).

on_open: ResRef

On-open script (OnOpen).

on_spell_cast_at: ResRef

On-spell-cast-at script (OnSpellCastAt).

on_unlock: ResRef

On-unlock script (OnUnlock).

on_used: ResRef

On-used script (OnUsed).

on_user_defined: ResRef

On-user-defined script (OnUserDefined).

on_dialog: ResRef

On-dialog script (OnDialog).

on_end_dialogue: ResRef

On-end-dialogue script (OnEndDialogue).

on_trap_triggered: ResRef

On-trap-triggered script (OnTrapTriggered).

on_fail_to_open: ResRef

On-fail-to-open script (OnFailToOpen).

inventory: Vec<UtpInventoryItem>

Inventory entries (ItemList).

Implementations

impl Utp

pub fn new() -> Self

Creates an empty UTP value.

pub fn trap_settings(&self) -> TrapSettings

Returns trap-related settings as a shared typed block.

pub fn set_trap_settings(&mut self, trap: TrapSettings)

Applies trap-related settings from a shared typed block.

pub fn common_trap_scripts(&self) -> CommonTrapScripts

Returns the common trap-script hooks as a shared typed bundle.

pub fn set_common_trap_scripts(&mut self, scripts: CommonTrapScripts)

Applies the common trap-script hooks from a shared typed bundle.

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

Builds typed UTP data from a parsed GFF container.

pub fn to_gff(&self) -> Gff

Converts this typed UTP value into a GFF container.

Trait Implementations

impl Clone for Utp

fn clone(&self) -> Utp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utp

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

Formats the value using the given formatter.

impl Default for Utp

fn default() -> Self

Returns the “default value” for a type.

impl GffSchema for Utp

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

Returns the root field schema for this GFF resource type.

impl PartialEq for Utp

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