Struct GitFile 

pub struct GitFile {
    pub area_properties: Option<GitAreaProperties>,
    pub creatures: Vec<GitCreature>,
    pub doors: Vec<GitDoor>,
    pub encounters: Vec<GitEncounter>,
    pub legacy_list: Vec<GffStruct>,
    pub sounds: Vec<GitSound>,
    pub stores: Vec<GitStore>,
    pub triggers: Vec<GitTrigger>,
    pub waypoints: Vec<GitWaypoint>,
    pub placeables: Vec<GitPlaceable>,
}

Parsed area instance payload.

Each typed collection preserves the authored instance ordering for its category. Where typed coverage is incomplete, the underlying raw GFF structures remain available on the typed entries or through GitFile::legacy_list.

Examples

let git = nwnrs_git::GitFile::default();
assert!(git.creatures.is_empty());

Fields

area_properties: Option<GitAreaProperties>

Optional ambient/music settings for the area.

creatures: Vec<GitCreature>

Placed creatures.

doors: Vec<GitDoor>

Placed doors.

encounters: Vec<GitEncounter>

Encounter volumes.

legacy_list: Vec<GffStruct>

Raw legacy top-level List entries, preserved verbatim.

sounds: Vec<GitSound>

Placed ambient or point sounds.

stores: Vec<GitStore>

Placed stores.

triggers: Vec<GitTrigger>

Trigger volumes.

waypoints: Vec<GitWaypoint>

Placed waypoints.

placeables: Vec<GitPlaceable>

Placed placeables.

Implementations

impl GitFile

pub fn from_file(path: impl AsRef<Path>) -> GitResult<Self>

Reads a typed GIT file from disk.

Errors

Returns GitError if the file cannot be opened or parsed.

Examples

let _ = nwnrs_git::GitFile::from_file;

pub fn from_res(res: &Res, cache_policy: CachePolicy) -> GitResult<Self>

Reads a typed GIT file from a Res.

Errors

Returns GitError if the resource is not a GIT type or the bytes cannot be parsed.

Examples

let _ = nwnrs_git::GitFile::from_res;

pub fn from_resman( resman: &mut ResMan, area_name: &str, cache_policy: CachePolicy, ) -> GitResult<Self>

Reads a typed GIT file from a ResMan by area name.

Errors

Returns GitError if the resource cannot be found or parsed.

Examples

let _ = nwnrs_git::GitFile::from_resman;

Trait Implementations

impl Clone for GitFile

fn clone(&self) -> GitFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitFile

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

Formats the value using the given formatter.

impl Default for GitFile

fn default() -> GitFile

Returns the “default value” for a type.

impl PartialEq for GitFile

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