Skip to main content

Module are

Module are 

Source
Expand description

Typed ARE (.are) model and conversion helpers. ARE (.are) typed generic wrapper.

ARE resources are GFF-backed area metadata containers.

§Scope

  • Typed access for all engine-read area fields (identity, scripts, map, core flags, weather, lighting, grass, stealth/transition save-state, and MiniGame struct).
  • Deterministic lossless conversion back to Gff.

§Field Layout (simplified)

ARE root struct
+-- Tag              (CExoString)
+-- Name             (CExoLocString)
+-- Comments         (CExoString)
+-- AlphaTest        (FLOAT)
+-- CameraStyle      (INT)
+-- DefaultEnvMap    (CResRef)
+-- RestrictMode     (BYTE)
+-- OnEnter/Exit/... (CResRef)
+-- Flags            (DWORD)
+-- Version          (DWORD)
+-- LoadScreenID     (WORD)
+-- ChanceRain/Snow/Lightning/Fog (INT)
+-- StealthXPCurrent (DWORD)
+-- TransPending/TransPendNextID/TransPendCurrID (BYTE)
+-- Expansion_List   (List<Struct>)
|   +-- Expansion_Name (CExoLocString)
|   `-- Expansion_ID   (INT)
+-- MiniGame         (Struct -> AreMiniGame, see [`minigame`])
+-- Map              (Struct)
|   +-- NorthAxis / MapZoom / MapResX
|   +-- MapPt{1,2}{X,Y} / WorldPt{1,2}{X,Y}
+-- Rooms            (List<Struct>)
    +-- RoomName / AmbientScale / EnvAudio / ForceRating / DisableWeather
    `-- PartSounds   (List<Struct>)
        +-- Looping / ModelPart / OmenEvent / Sound

Re-exports§

pub use minigame::AreMiniGame;
pub use minigame::AreMiniGameBullet;
pub use minigame::AreMiniGameEnemy;
pub use minigame::AreMiniGameGunBank;
pub use minigame::AreMiniGameModel;
pub use minigame::AreMiniGameMouse;
pub use minigame::AreMiniGameObjectScripts;
pub use minigame::AreMiniGameObstacle;
pub use minigame::AreMiniGamePlayer;
pub use minigame::AreMiniGameSounds;
pub use minigame::AreMiniGameTargeting;
pub use minigame::AreMiniGameVehicle;
pub use minigame::AreMiniGameVehicleScripts;
pub use minigame::BANK_ID_NONE;

Modules§

minigame
Typed views over the ARE MiniGame subsystem.

Structs§

Are
Typed ARE model built from/to [Gff] data.
AreExpansionEntry
Typed view over one ARE expansion-list entry.
AreMap
Typed view over the ARE Map nested struct.
ArePartSound
Typed view over one room part-sound entry (Rooms[].PartSounds[]).
AreRoom
Typed view over one ARE room entry in the Rooms list.

Enums§

AreError
Errors produced while reading or writing typed ARE data.

Functions§

read_are
Reads typed ARE data from a reader at the current stream position.
read_are_from_bytes
Reads typed ARE data directly from bytes.
write_are
Writes typed ARE data to an output writer.
write_are_to_vec
Serializes typed ARE data into a byte vector.