Struct Git 

pub struct Git {

    pub area_map: Option<GitAreaMap>,
    pub current_weather: u8,
    pub weather_started: bool,
    pub waypoints: Vec<GitWaypoint>,
    pub encounters: Vec<GitEncounter>,
    pub area_effects: Vec<GitAreaEffect>,
    pub area_properties: Option<GitAreaProperties>,
    pub cameras: Vec<GitCamera>,
    pub creatures: GitCreatures,
    pub items: GitItems,
    pub doors: GitDoors,
    pub placeables: GitPlaceables,
    pub sounds: GitSounds,
    pub triggers: GitTriggers,
    pub stores: GitStores,
}

Typed GIT model built from/to Gff data.

GIT is the area instance container. It places object instances by referencing templates and providing position/orientation data. All engine-read fields are typed; roundtrip is fully lossless for typed fields.

Fields

area_map: Option<GitAreaMap>

The explored-map bitmap (AreaMap), declared and not modelled.

Save-only. AreaMapData appears in every save fixture and in no module GIT the install ships, so writing the block unconditionally would put an explored map on an area nobody has walked.

current_weather: u8

Current weather (CurrentWeather). If area is an interior, engine forcibly overrides to 0xFF.

weather_started: bool

Weather started flag (WeatherStarted). If area is an interior, engine forcibly overrides to 0 (false).

waypoints: Vec<GitWaypoint>

Waypoint instances (WaypointList).

encounters: Vec<GitEncounter>

Encounter instances (Encounter List).

Read as static placements whatever UseTemplates says, which is wrong for a savegame GIT: a saved encounter comes back with an empty TemplateResRef rather than its spawned state. Encounters are the one object list still in that position. They are held back because there is nothing to model them against: every save in fixtures/saves/ has an empty Encounter List, and unlike area effects the engine’s saved encounter field set is not written down in docs/src/formats/gff/git.md either. Modelling it from LoadEncounters alone would ship a field set with no way to check it.

area_effects: Vec<GitAreaEffect>

Area-of-effect instances (AreaEffectList).

area_properties: Option<GitAreaProperties>

Area-level properties (AreaProperties).

cameras: Vec<GitCamera>

Static cameras (CameraList). Engine load failure occurs if array contains 51 or more entries.

creatures: GitCreatures

Creature List instances, in whichever form the file uses.

items: GitItems

List instances, in whichever form the file uses.

doors: GitDoors

Door List instances, in whichever form the file uses.

placeables: GitPlaceables

Placeable List instances, in whichever form the file uses.

sounds: GitSounds

SoundList instances, in whichever form the file uses.

triggers: GitTriggers

TriggerList instances, in whichever form the file uses.

stores: GitStores

StoreList instances, in whichever form the file uses.

Implementations

impl Git

pub const SCHEMA: [Field; 17]

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 Git

pub fn new() -> Self

Creates an empty GIT value.

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

Builds typed GIT data from a parsed GFF container.

Errors

Returns GitError::UnsupportedFileType when the container is not a GIT or a bare GFF .

pub fn to_gff(&self) -> Gff

Converts this typed GIT value into a GFF container.

Trait Implementations

impl Clone for Git

fn clone(&self) -> Git

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Git

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

Formats the value using the given formatter.

impl Default for Git

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 Git

const MAGIC: [u8; 4]

The four bytes a container of this format carries.

type Error = GitError

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 Git

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 Git

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