Struct SavedTrigger 

pub struct SavedTrigger {

    pub portrait: SavedPortrait,
    pub trap_detectable: bool,
    pub trap_disarmable: bool,
    pub trap_one_shot: bool,
    pub trap_type: u8,
    pub common: GitTriggerCommon,
    pub tag: String,
    pub geometry: Vec<UttGeometryPoint>,
    pub auto_remove_key: bool,
    pub commandable: bool,
    pub creator_id: u32,
    pub cursor: u8,
    pub faction: u32,
    pub highlight_height: f32,
    pub key_name: String,
    pub load_screen_id: u16,
    pub localized_name: GffLocalizedString,
    pub on_click: ResRef,
    pub on_disarm: ResRef,
    pub on_trap_triggered: ResRef,
    pub script_heartbeat: ResRef,
    pub script_on_enter: ResRef,
    pub script_on_exit: ResRef,
    pub script_user_define: ResRef,
    pub set_by_player_party: bool,
    pub trigger_type: i32,
}

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

Fields

portrait: SavedPortrait

Portrait, as whichever of the two labels the trigger carries.

Declared per owner: the audit parts both labels from the door’s and the placeable’s on the absent axis.

trap_detectable: bool

Whether the trap can be spotted (TrapDetectable).

trap_disarmable: bool

Whether the trap can be disarmed (TrapDisarmable).

trap_one_shot: bool

Whether the trap fires once and clears (TrapOneShot).

trap_type: u8

Trap row in traps.2da (TrapType).

common: GitTriggerCommon

The block both forms carry, which the list declares as its element.

No #[gff]: the arm contributes its parts to the split, and the element is this block, so declaring it here too would make one label two declarations. The arm’s own codec reads and writes it.

tag: String

Object tag (Tag).

geometry: Vec<UttGeometryPoint>

Polygon defining the trigger area (Geometry).

auto_remove_key: bool

Consume the key on use (AutoRemoveKey).

commandable: bool

Accepts scripted commands (Commandable).

creator_id: u32

Object that created this trigger at runtime (CreatorId).

cursor: u8

Cursor shown over the trigger (Cursor).

faction: u32

Faction id (Faction).

highlight_height: f32

Highlight rendering height (HighlightHeight).

key_name: String

Key tag that disarms this trigger (KeyName).

load_screen_id: u16

Load screen shown across the transition (LoadScreenID).

localized_name: GffLocalizedString

Displayed name (LocalizedName).

on_click: ResRef

OnClick.

on_disarm: ResRef

OnDisarm.

on_trap_triggered: ResRef

OnTrapTriggered.

script_heartbeat: ResRef

ScriptHeartbeat.

script_on_enter: ResRef

ScriptOnEnter.

script_on_exit: ResRef

ScriptOnExit.

script_user_define: ResRef

ScriptUserDefine.

set_by_player_party: bool

Placed by the player party at runtime (SetByPlayerParty).

trigger_type: i32

Trigger kind (Type): generic, area transition, or trap.

Implementations

impl SavedTrigger

pub const SCHEMA: [Field; 24]

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 SavedTrigger

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

Reads one element, resolving the portrait’s two labels into one value.

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

Writes one element, emitting whichever portrait label the value uses.

Trait Implementations

impl Clone for SavedTrigger

fn clone(&self) -> SavedTrigger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SavedTrigger

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

Formats the value using the given formatter.

impl Default for SavedTrigger

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 GitElement for SavedTrigger

fn read(structure: &GffStruct) -> Self

Reads one element.

fn write(&self, id: i32) -> GffStruct

Writes one element into a struct carrying the list’s own id.

impl HasSchema for SavedTrigger

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 SavedTrigger

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