Struct SavedPlaceable 

pub struct SavedPlaceable {

    pub tag: String,
    pub object_id: ObjectId,
    pub appearance: u32,
    pub animation: i32,
    pub loc_name: GffLocalizedString,
    pub description: GffLocalizedString,
    pub portrait: SavedPortrait,
    pub x: f32,
    pub y: f32,
    pub z: f32,
    pub bearing: f32,
    pub current_hp: i16,
    pub hp: i16,
    pub hardness: u8,
    pub fortitude: u8,
    pub reflex: u8,
    pub will: u8,
    pub min1_hp: bool,
    pub plot: bool,
    pub is_static: bool,
    pub commandable: bool,
    pub faction: u32,
    pub useable: bool,
    pub party_interact: bool,
    pub open: bool,
    pub light_state: u8,
    pub has_inventory: bool,
    pub die_when_empty: bool,
    pub ground_pile: bool,
    pub body_bag: u8,
    pub is_body_bag: bool,
    pub is_body_bag_visible: bool,
    pub is_corpse: bool,
    pub items: Vec<SavedItem>,
    pub lockable: bool,
    pub locked: bool,
    pub open_lock_dc: u8,
    pub close_lock_dc: u8,
    pub key_name: String,
    pub key_required: bool,
    pub auto_remove_key: bool,
    pub trap: TrapSettings,
    pub conversation: ResRef,
    pub on_closed: ResRef,
    pub on_damaged: ResRef,
    pub on_death: ResRef,
    pub on_dialog: ResRef,
    pub on_disarm: ResRef,
    pub on_end_dialogue: ResRef,
    pub on_heartbeat: ResRef,
    pub on_inv_disturbed: ResRef,
    pub on_lock: ResRef,
    pub on_melee_attacked: ResRef,
    pub on_open: ResRef,
    pub on_spell_cast_at: ResRef,
    pub on_trap_triggered: ResRef,
    pub on_unlock: ResRef,
    pub on_used: ResRef,
    pub on_user_defined: ResRef,
}

A placeable as stored inside a save game’s module GIT.

Fields

tag: String

Object tag (Tag).

object_id: ObjectId

Runtime object id (ObjectId).

appearance: u32

Appearance row (Appearance), into placeables.2da.

animation: i32

Current animation state (Animation).

loc_name: GffLocalizedString

Displayed name (LocName).

description: GffLocalizedString

Description (Description).

portrait: SavedPortrait

Portrait, in whichever of its two forms the object uses.

x: f32

World X position (X).

y: f32

World Y position (Y).

z: f32

World Z position (Z).

bearing: f32

Facing, in radians (Bearing).

current_hp: i16

Current hit points (CurrentHP).

hp: i16

Maximum hit points (HP).

hardness: u8

Damage reduction (Hardness).

fortitude: u8

Fortitude save (Fort).

reflex: u8

Reflex save (Ref).

will: u8

Will save (Will).

min1_hp: bool

Cannot be reduced below 1 HP (Min1HP).

plot: bool

Plot flag (Plot).

is_static: bool

Static, non-interactive geometry (Static).

commandable: bool

Accepts scripted commands (Commandable).

faction: u32

Faction id (Faction).

useable: bool

Can be interacted with at all (Useable).

party_interact: bool

Party members may use it directly (PartyInteract).

open: bool

Currently open (Open).

light_state: u8

Light state (LightState).

has_inventory: bool

Holds an inventory (HasInventory).

die_when_empty: bool

Destroy the object once emptied (DieWhenEmpty).

ground_pile: bool

Renders as a loose pile rather than a container (GroundPile).

body_bag: u8

Body-bag row (BodyBag).

is_body_bag: bool

Is a body bag (IsBodyBag).

is_body_bag_visible: bool

Body bag is visible (IsBodyBagVisible).

is_corpse: bool

Is a corpse (IsCorpse).

items: Vec<SavedItem>

Container contents (ItemList). Empty writes no field at all.

lockable: bool

Can be locked at all (Lockable).

locked: bool

Currently locked (Locked).

open_lock_dc: u8

DC to pick the lock (OpenLockDC).

close_lock_dc: u8

DC to re-lock (CloseLockDC).

key_name: String

Key tag that opens this placeable (KeyName).

key_required: bool

A key is required regardless of lock DC (KeyRequired).

auto_remove_key: bool

Consume the key on use (AutoRemoveKey).

trap: TrapSettings

Trap configuration (TrapDetectable, TrapDetectDC, …).

conversation: ResRef

Attached conversation (Conversation).

on_closed: ResRef

OnClosed.

on_damaged: ResRef

OnDamaged.

on_death: ResRef

OnDeath.

on_dialog: ResRef

OnDialog.

on_disarm: ResRef

OnDisarm.

on_end_dialogue: ResRef

OnEndDialogue.

on_heartbeat: ResRef

OnHeartbeat.

on_inv_disturbed: ResRef

OnInvDisturbed.

on_lock: ResRef

OnLock.

on_melee_attacked: ResRef

OnMeleeAttacked.

on_open: ResRef

OnOpen.

on_spell_cast_at: ResRef

OnSpellCastAt.

on_trap_triggered: ResRef

OnTrapTriggered.

on_unlock: ResRef

OnUnlock.

on_used: ResRef

OnUsed.

on_user_defined: ResRef

OnUserDefined.

Implementations

impl SavedPlaceable

pub fn new() -> Self

Creates an empty saved placeable.

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

Reads one saved Placeable List element.

pub fn to_struct(&self, index: usize) -> GffStruct

Writes this placeable back into a Placeable List element.

Trait Implementations

impl Clone for SavedPlaceable

fn clone(&self) -> SavedPlaceable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SavedPlaceable

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

Formats the value using the given formatter.

impl Default for SavedPlaceable

fn default() -> SavedPlaceable

Returns the “default value” for a type.

impl PartialEq for SavedPlaceable

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