Skip to main content

Module git

Module git 

Source
Expand description

Typed GIT (.git) model 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 door::GitDoor;
pub use encounter::GitEncounter;
pub use encounter::GitEncounterPoint;
pub use encounter::GitSpawnPoint;
pub use item::GitItem;
pub use placeable::GitPlaceable;
pub use sound::GitSound;
pub use store::GitStore;
pub use trigger::GitTrigger;
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.
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.

Enums§

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

Functions§

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.
write_git
Writes typed GIT data to an output writer.
write_git_to_vec
Serializes typed GIT data into a byte vector.

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.