Struct Are 

pub struct Are {

    pub unused_id: i32,
    pub creator_id: i32,
    pub version: u32,
    pub comment: String,
    pub name: GffLocalizedString,
    pub tag: String,
    pub on_heartbeat: ResRef,
    pub on_user_defined: ResRef,
    pub on_enter: ResRef,
    pub on_exit: ResRef,
    pub flags: u32,
    pub camera_style: i32,
    pub default_envmap: ResRef,
    pub unescapable: bool,
    pub restrict_mode: u8,
    pub chance_rain: i32,
    pub chance_snow: i32,
    pub chance_lightning: i32,
    pub wind_power: i32,
    pub chance_fog: i32,
    pub moon_ambient_color: u32,
    pub moon_diffuse_color: u32,
    pub moon_fog_color: u32,
    pub sun_ambient_color: u32,
    pub sun_diffuse_color: u32,
    pub sun_fog_color: u32,
    pub dynamic_ambient_color: u32,
    pub moon_fog_near: f32,
    pub moon_fog_far: f32,
    pub fog_near: f32,
    pub fog_far: f32,
    pub moon_fog_enabled: bool,
    pub fog_enabled: bool,
    pub moon_shadows: bool,
    pub shadows: bool,
    pub day_night_cycle: u8,
    pub is_night: bool,
    pub shadow_opacity: u8,
    pub lighting_scheme: u8,
    pub no_rest: bool,
    pub mod_spot_check: i32,
    pub mod_listen_check: i32,
    pub grass_diffuse_color: u32,
    pub grass_ambient_color: u32,
    pub grass_density: f32,
    pub grass_size: f32,
    pub grass_texture: ResRef,
    pub grass_prob_ll: f32,
    pub grass_prob_lr: f32,
    pub grass_prob_ul: f32,
    pub grass_prob_ur: f32,
    pub alpha_test: f32,
    pub stealth_xp_max: u32,
    pub stealth_xp_current: u32,
    pub stealth_xp_loss: u32,
    pub stealth_xp: bool,
    pub trans_pending: u8,
    pub trans_pend_next_id: u8,
    pub trans_pend_curr_id: u8,
    pub loadscreen_id: u16,
    pub rooms: Vec<AreRoom>,
    pub expansion_list: Vec<AreExpansionEntry>,
    pub map: AreMap,
    pub mini_game: Option<AreMiniGame>,
    pub disable_transit: bool,
    pub no_hang_back: bool,
    pub player_only: bool,
    pub player_vs_player: u8,
    pub grass_emissive_color: u32,
    pub dirty_argb_one: i32,
    pub dirty_size_one: i32,
    pub dirty_formula_one: i32,
    pub dirty_func_one: i32,
    pub dirty_argb_two: i32,
    pub dirty_size_two: i32,
    pub dirty_formula_two: i32,
    pub dirty_func_two: i32,
    pub dirty_argb_three: i32,
    pub dirty_size_three: i32,
    pub dirty_formula_three: i32,
    pub dirty_func_three: i32,
}

Typed ARE model built from/to Gff data.

Fields

unused_id: i32

Legacy area id (ID).

creator_id: i32

Legacy creator id (Creator_ID).

version: u32

Area format version (Version).

comment: String

Toolset/comment field (Comments).

name: GffLocalizedString

Localized area name (Name).

tag: String

Area tag (Tag). Engine always lowercases this on load.

on_heartbeat: ResRef

Heartbeat script resref (OnHeartbeat).

on_user_defined: ResRef

User-defined event script resref (OnUserDefined).

on_enter: ResRef

Enter script resref (OnEnter).

on_exit: ResRef

Exit script resref (OnExit).

flags: u32

Area flags (Flags).

camera_style: i32

Camera style ID (CameraStyle).

default_envmap: ResRef

Default environment map resref (DefaultEnvMap).

unescapable: bool

Unescapable area flag (Unescapable).

restrict_mode: u8

Restrict mode (RestrictMode) - triggers UnstealthParty on non-zero change.

chance_rain: i32

Chance of rain (ChanceRain, K2). Engine discards if interior. Truncated to byte (0-255) at runtime.

chance_snow: i32

Chance of snow (ChanceSnow, K2). Engine discards if interior. Truncated to byte (0-255) at runtime.

chance_lightning: i32

Chance of lightning (ChanceLightning, K2). Engine discards if interior. Truncated to byte (0-255) at runtime.

wind_power: i32

Wind power (WindPower). Engine discards if interior. Truncated to byte (0-255) at runtime.

chance_fog: i32

Chance of fog (ChanceFog).

moon_ambient_color: u32

Moon ambient color (MoonAmbientColor).

moon_diffuse_color: u32

Moon diffuse color (MoonDiffuseColor).

moon_fog_color: u32

Moon fog color (MoonFogColor).

sun_ambient_color: u32

Sun ambient color (SunAmbientColor).

sun_diffuse_color: u32

Sun diffuse color (SunDiffuseColor).

sun_fog_color: u32

Sun fog color (SunFogColor).

dynamic_ambient_color: u32

Dynamic ambient color (DynAmbientColor).

moon_fog_near: f32

Moon fog near distance (MoonFogNear). Clamped to >= 0.0 by the engine.

The absent value is far enough out that fog is effectively off, which is a different outcome from the 0.0 a reader reaching for a plain zero would produce. All four *FogNear/*FogFar reads resolve to it.

moon_fog_far: f32

Moon fog far distance (MoonFogFar). Clamped to >= 0.0 by the engine.

fog_near: f32

Sun fog near distance (SunFogNear). Clamped to >= 0.0 by the engine.

fog_far: f32

Sun fog far distance (SunFogFar). Clamped to >= 0.0 by the engine.

moon_fog_enabled: bool

Moon fog enabled (MoonFogOn).

fog_enabled: bool

Sun fog enabled (SunFogOn).

moon_shadows: bool

Moon shadows enabled (MoonShadows).

shadows: bool

Sun shadows enabled (SunShadows).

day_night_cycle: u8

Day/night cycle flag (DayNightCycle).

is_night: bool

Is-night flag (IsNight).

shadow_opacity: u8

Shadow opacity (ShadowOpacity).

lighting_scheme: u8

Lighting scheme (LightingScheme).

no_rest: bool

No-rest flag (NoRest).

mod_spot_check: i32

Mod spot-check modifier (ModSpotCheck).

mod_listen_check: i32

Mod listen-check modifier (ModListenCheck).

grass_diffuse_color: u32

Grass diffuse color (Grass_Diffuse).

grass_ambient_color: u32

Grass ambient color (Grass_Ambient).

grass_density: f32

Grass density (Grass_Density).

grass_size: f32

Grass quad size (Grass_QuadSize).

grass_texture: ResRef

Grass texture resref (Grass_TexName).

grass_prob_ll: f32

Grass probability lower-left (Grass_Prob_LL).

grass_prob_lr: f32

Grass probability lower-right (Grass_Prob_LR).

grass_prob_ul: f32

Grass probability upper-left (Grass_Prob_UL).

grass_prob_ur: f32

Grass probability upper-right (Grass_Prob_UR).

alpha_test: f32

Alpha test threshold (AlphaTest).

stealth_xp_max: u32

Stealth XP max (StealthXPMax).

stealth_xp_current: u32

Current stealth XP counter (StealthXPCurrent, save-state).

A chained default, not an independent one: the engine’s read falls back to whatever StealthXPMax just resolved to. A plain zero here starts an area with no stealth budget where the engine would start it with the full one, which is why the read is this view’s.

Not clamped to the max afterwards, though the engine does clamp. That happens after the read and is resolution rather than the file’s own content, and this view projects the file.

stealth_xp_loss: u32

Stealth XP loss (StealthXPLoss).

stealth_xp: bool

Stealth XP enabled (StealthXPEnabled).

trans_pending: u8

Transition pending flag (TransPending, save-state).

trans_pend_next_id: u8

Transition pending next ID (TransPendNextID, save-state).

trans_pend_curr_id: u8

Transition pending current ID (TransPendCurrID, save-state).

loadscreen_id: u16

Load screen ID (LoadScreenID).

rooms: Vec<AreRoom>

Embedded room metadata (Rooms list).

expansion_list: Vec<AreExpansionEntry>

Area expansion entries (Expansion_List list).

map: AreMap

Embedded map metadata (Map struct).

mini_game: Option<AreMiniGame>

MiniGame struct (MiniGame).

disable_transit: bool

Disable transit flag (DisableTransit). Toolset/K2-specific, ignored by K1 engine.

no_hang_back: bool

No-hang-back flag (NoHangBack). Toolset/K2-specific, ignored by K1 engine.

player_only: bool

Player-only flag (PlayerOnly). Toolset/K2-specific, ignored by K1 engine.

player_vs_player: u8

Player-vs-player mode (PlayerVsPlayer). Toolset/K2-specific, ignored by K1 engine.

grass_emissive_color: u32

Grass emissive color (Grass_Emissive).

dirty_argb_one: i32

Dirty overlay color one (DirtyARGBOne).

dirty_size_one: i32

Dirty overlay size one (DirtySizeOne).

dirty_formula_one: i32

Dirty overlay formula one (DirtyFormulaOne).

dirty_func_one: i32

Dirty overlay func one (DirtyFuncOne).

dirty_argb_two: i32

Dirty overlay color two (DirtyARGBTwo).

dirty_size_two: i32

Dirty overlay size two (DirtySizeTwo).

dirty_formula_two: i32

Dirty overlay formula two (DirtyFormulaTwo).

dirty_func_two: i32

Dirty overlay func two (DirtyFuncTwo).

dirty_argb_three: i32

Dirty overlay color three (DirtyARGBThree).

dirty_size_three: i32

Dirty overlay size three (DirtySizeThree).

dirty_formula_three: i32

Dirty overlay formula three (DirtyFormulaThre).

dirty_func_three: i32

Dirty overlay func three (DirtyFuncThree).

Implementations

impl Are

pub const SCHEMA: [Field; 81]

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 Are

pub fn new() -> Self

Creates an empty ARE value.

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

Builds typed ARE data from a parsed GFF container.

Errors

Returns AreError::UnsupportedFileType when the container is not an ARE or a bare GFF .

pub fn to_gff(&self) -> Gff

Serializes typed ARE data back into a GFF container.

Trait Implementations

impl Clone for Are

fn clone(&self) -> Are

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Are

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

Formats the value using the given formatter.

impl Default for Are

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 FromGff for Are

const MAGIC: [u8; 4]

The four bytes a container of this format carries.

type Error = AreError

What reading this view out of a tree can fail with.

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

Reads the view. Anything the view does not model stays in gff.

impl HasSchema for Are

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 Are

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