Struct GitAreaProperties 

pub struct GitAreaProperties {

    pub unescapable: bool,
    pub stealth_xp_max: u32,
    pub stealth_xp_current: u32,
    pub stealth_xp_loss: u32,
    pub stealth_xp_enabled: bool,
    pub trans_pending: bool,
    pub trans_pend_next_id: u8,
    pub trans_pend_curr_id: u8,
    pub sun_fog_color: u32,
    pub music_delay: i32,
    pub music_day: i32,
    pub music_night: i32,
    pub music_battle: i32,
    pub ambient_snd_day: i32,
    pub ambient_snd_night: i32,
    pub ambient_snd_day_vol: i32,
    pub ambient_snd_nit_vol: i32,
}

Area-level properties (music, ambient sound, stealth XP, fog).

This is a single Struct in the GIT root (field label AreaProperties).

Fields

unescapable: bool

Unescapable flag (Unescapable).

stealth_xp_max: u32

Stealth XP maximum (StealthXPMax).

stealth_xp_current: u32

Current stealth XP count (StealthXPCurrent). Save-game state. Natively clamped by the engine to not exceed StealthXPMax.

stealth_xp_loss: u32

Stealth XP loss per detection (StealthXPLoss).

stealth_xp_enabled: bool

Stealth XP enabled flag (StealthXPEnabled).

trans_pending: bool

Transition pending flag (TransPending). Save-game state.

trans_pend_next_id: u8

Pending transition next ID (TransPendNextID). Save-game state.

trans_pend_curr_id: u8

Pending transition current ID (TransPendCurrID). Save-game state.

sun_fog_color: u32

Sun/fog color packed as RGBA (SunFogColor).

music_delay: i32

Music delay in ms (MusicDelay).

music_day: i32

Daytime music track ID (MusicDay). References ambientmusic.2da.

music_night: i32

Night-time music track ID (MusicNight). References ambientmusic.2da.

music_battle: i32

Battle music track ID (MusicBattle). References ambientmusic.2da.

ambient_snd_day: i32

Daytime ambient sound ID (AmbientSndDay). References ambientsound.2da.

ambient_snd_night: i32

Night-time ambient sound ID (AmbientSndNight). References ambientsound.2da.

ambient_snd_day_vol: i32

Daytime ambient sound volume (AmbientSndDayVol). Values outside 0-255 are truncated and wrapped to an 8-bit byte.

ambient_snd_nit_vol: i32

Night-time ambient sound volume (AmbientSndNitVol). Values outside 0-255 are truncated and wrapped to an 8-bit byte.

Implementations

impl GitAreaProperties

pub const SCHEMA: [Field; 18]

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.

Trait Implementations

impl Clone for GitAreaProperties

fn clone(&self) -> GitAreaProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitAreaProperties

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

Formats the value using the given formatter.

impl Default for GitAreaProperties

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 HasSchema for GitAreaProperties

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 GitAreaProperties

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