Skip to main content

Module git

Module git 

Source
Expand description

Typed GIT (.git) area instance layout and conversion helpers. GIT (.git) typed generic wrapper.

GIT (Game Instance Template) resources are GFF-backed area instance data. Each area has one GIT that holds positioned object instances (creatures, items, doors, placeables, waypoints, sounds, triggers, stores, encounters, area effects), area-level properties (music, ambient sounds, stealth XP), and a camera list.

§Scope

  • Typed access for all 10 instance list types with position/orientation.
  • Typed AreaProperties with music, ambient sound, and stealth XP fields.
  • Typed camera list with Position (Vector3) and Orientation (Quaternion).
  • Full typed roundtrip for all engine-read fields.

Re-exports§

pub use area_effect::GitAreaEffect;
pub use area_effect::GitAreaEffectShape;
pub use area_properties::GitAreaProperties;
pub use camera::GitCamera;
pub use creature::GitCreature;
pub use creature::GitCreatureCommon;
pub use door::GitDoor;
pub use door::GitDoorCommon;
pub use encounter::GitEncounter;
pub use encounter::GitEncounterPoint;
pub use encounter::GitSpawnPoint;
pub use item::GitItem;
pub use placeable::GitPlaceable;
pub use placeable::GitPlaceableCommon;
pub use sound::GitSound;
pub use sound::GitSoundCommon;
pub use store::GitStore;
pub use trigger::GitTrigger;
pub use trigger::GitTriggerCommon;
pub use waypoint::GitMapNote;
pub use waypoint::GitWaypoint;

Modules§

area_effect
Area-of-effect objects, which savegame GITs carry and module GITs do not.
area_properties
Area-level properties and the map block, both single structs on the GIT root.
blocks
Field blocks more than one GIT object type declares.
camera
Static camera entries in a GIT.
creature
Creature placements in a GIT.
door
Door placements in a GIT.
encounter
Encounter placements in a GIT, with their geometry and spawn points.
item
Item placements in a GIT.
placeable
Placeable placements in a GIT.
sound
Sound placements in a GIT.
store
Store placements in a GIT.
trigger
Trigger placements in a GIT.
waypoint
Waypoint placements in a GIT, and the map note one can carry.

Structs§

Git
Typed GIT model built from/to Gff data.
GitAreaMap
The area’s explored-map bitmap, which the view declares and does not model.
GitObjectPlacement
Where an item entry or a store entry sits, whichever form the entry takes.

Enums§

GitError
Errors produced while reading or writing typed GIT data.
GitObjects
The two forms an object list in a GIT can take.

Traits§

GitElement
One arm’s element codec, so a list can read or write either side without naming which.

Functions§

author_git
Authors the GIT file the typed view describes, into a writer.
author_git_to_vec
Authors the GIT file the typed view describes, as bytes.
read_git
Reads typed GIT data from a reader at the current stream position.
read_git_from_bytes
Reads typed GIT data directly from bytes.

Type Aliases§

GitCreatures
A Creature List in either of its two forms.
GitDoors
A Door List in either of its two forms.
GitItems
A List of loose area items in either of its two forms.
GitPlaceables
A Placeable List in either of its two forms.
GitSounds
A SoundList in either of its two forms.
GitStores
A StoreList in either of its two forms.
GitTriggers
A TriggerList in either of its two forms.