Struct Git 

pub struct Git {

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

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

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).

creatures: GitCreatures

Creature instances (Creature List), in whichever form the file uses.

The UseTemplates discriminator lives here rather than as a separate flag, so the two cannot disagree about what the list contains.

items: GitItems

Item instances (List), in whichever form the file uses.

doors: GitDoors

Door instances (Door List), in whichever form the file uses.

placeables: GitPlaceables

Placeable instances (Placeable List), in whichever form the file uses.

waypoints: Vec<GitWaypoint>

Waypoint instances (WaypointList).

sounds: GitSounds

Sound instances (SoundList), in whichever form the file uses.

triggers: GitTriggers

Trigger instances (TriggerList), in whichever form the file uses.

stores: GitStores

Store instances (StoreList), in whichever form the file uses.

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.

Implementations

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.

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() -> Git

Returns the “default value” for a type.

impl GffSchema for Git

fn schema() -> &'static [FieldSchema]

Returns the root field schema for this GFF resource type.

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