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)
| +-- Type / MovementPerSec / LateralAccel / Bump_Plane
| +-- DoBumping / UseInertia / DOF / Music
| +-- Far_Clip / Near_Clip / CameraViewAngle
| `-- Player (Struct -> AreMiniGamePlayer)
| +-- Models (List<AreMiniGameModel>)
| +-- Track / Camera / CameraRotate
| +-- Mouse (Struct -> AreMiniGameMouse)
| +-- Enemies (List<AreMiniGameEnemy>)
| `-- Obstacles (List<AreMiniGameObstacle>)
+-- 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 / SoundStructs§
- Are
- Typed ARE model built from/to
Gffdata. - AreExpansion
Entry - Typed view over one ARE expansion-list entry.
- AreMap
- Typed view over the ARE
Mapnested struct. - AreMini
Game - Typed view over the ARE
MiniGamenested struct. - AreMini
Game Enemy - Typed view over one enemy entry in
MiniGame.Player.Enemies. - AreMini
Game Model - Typed view over one model entry in a mini-game model list.
- AreMini
Game Mouse - Typed view over the
MiniGame.Player.Mousesub-struct. - AreMini
Game Obstacle - Typed view over one obstacle entry in
MiniGame.Player.Obstacles. - AreMini
Game Player - Typed view over the
MiniGame.Playersub-struct. - ArePart
Sound - Typed view over one room part-sound entry (
Rooms[].PartSounds[]). - AreRoom
- Typed view over one ARE room entry in the
Roomslist.
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.