Struct SavedTrigger 

pub struct SavedTrigger {

    pub tag: String,
    pub object_id: ObjectId,
    pub creator_id: u32,
    pub trigger_type: i32,
    pub localized_name: GffLocalizedString,
    pub portrait: SavedPortrait,
    pub faction: u32,
    pub cursor: u8,
    pub highlight_height: f32,
    pub commandable: bool,
    pub set_by_player_party: bool,
    pub x_position: f32,
    pub y_position: f32,
    pub z_position: f32,
    pub x_orientation: f32,
    pub y_orientation: f32,
    pub z_orientation: f32,
    pub geometry: Vec<GitTriggerPoint>,
    pub linked_to: String,
    pub linked_to_flags: u8,
    pub linked_to_module: ResRef,
    pub transition_destin: GffLocalizedString,
    pub load_screen_id: u16,
    pub key_name: String,
    pub auto_remove_key: bool,
    pub trap_detectable: bool,
    pub trap_disarmable: bool,
    pub trap_one_shot: bool,
    pub trap_type: u8,
    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,
}

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

Fields

tag: String

Object tag (Tag).

object_id: ObjectId

Runtime object id (ObjectId).

creator_id: u32

Object that created this trigger at runtime (CreatorId).

trigger_type: i32

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

localized_name: GffLocalizedString

Displayed name (LocalizedName).

portrait: SavedPortrait

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

faction: u32

Faction id (Faction).

cursor: u8

Cursor shown over the trigger (Cursor).

highlight_height: f32

Highlight rendering height (HighlightHeight).

commandable: bool

Accepts scripted commands (Commandable).

set_by_player_party: bool

Placed by the player party at runtime (SetByPlayerParty).

x_position: f32

World X position (XPosition).

y_position: f32

World Y position (YPosition).

z_position: f32

World Z position (ZPosition).

x_orientation: f32

Facing X component (XOrientation).

y_orientation: f32

Facing Y component (YOrientation).

z_orientation: f32

Facing Z component (ZOrientation).

geometry: Vec<GitTriggerPoint>

Polygon defining the trigger area (Geometry).

linked_to: String

Area transition target tag (LinkedTo).

linked_to_flags: u8

Transition kind (LinkedToFlags).

linked_to_module: ResRef

Target module for a cross-module transition (LinkedToModule).

transition_destin: GffLocalizedString

Transition tooltip text (TransitionDestin).

load_screen_id: u16

Load screen shown across the transition (LoadScreenID).

key_name: String

Key tag that disarms this trigger (KeyName).

auto_remove_key: bool

Consume the key on use (AutoRemoveKey).

trap_detectable: bool

Trap can be spotted (TrapDetectable).

trap_disarmable: bool

Trap can be disarmed (TrapDisarmable).

trap_one_shot: bool

Trap fires once and is spent (TrapOneShot).

trap_type: u8

Trap row (TrapType).

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.

Implementations

impl SavedTrigger

pub fn new() -> Self

Creates an empty saved trigger.

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

Reads one saved TriggerList element.

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

Writes this trigger back into a TriggerList element.

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() -> SavedTrigger

Returns the “default value” for a type.

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