Struct SetFile 

pub struct SetFile {
    pub general: SetGeneral,
    pub grass: Option<SetGrass>,
    pub terrains: BTreeMap<u32, SetNamedType>,
    pub crossers: BTreeMap<u32, SetNamedType>,
    pub primary_rules: BTreeMap<u32, SetPrimaryRule>,
    pub tiles: BTreeMap<u32, SetTile>,
    pub tile_doors: BTreeMap<(u32, u32), SetTileDoor>,
    pub groups: BTreeMap<u32, SetGroup>,
}

Parsed tileset payload.

The representation preserves the authored section structure explicitly: top-level metadata, terrain and crosser catalogs, primary rules, tiles, tile-door metadata, and groups remain distinct keyed collections rather than being flattened into one generic map.

Examples

let set_file = nwnrs_set::SetFile::default();
assert!(set_file.tiles.is_empty());

Fields

general: SetGeneral

Top-level [GENERAL] metadata.

grass: Option<SetGrass>

Optional [GRASS] block.

terrains: BTreeMap<u32, SetNamedType>

[TERRAINN] entries keyed by terrain id.

crossers: BTreeMap<u32, SetNamedType>

[CROSSERN] entries keyed by crosser id.

primary_rules: BTreeMap<u32, SetPrimaryRule>

[PRIMARY RULEN] entries keyed by rule id.

tiles: BTreeMap<u32, SetTile>

[TILEN] entries keyed by tile id.

tile_doors: BTreeMap<(u32, u32), SetTileDoor>

[TILENMDOORK] entries keyed by (tile_id, door_id).

groups: BTreeMap<u32, SetGroup>

[GROUPN] entries keyed by group id.

Implementations

impl SetFile

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

Reads a typed SET file from disk.

Errors

Returns SetError if the file cannot be opened or parsed.

Examples

let _ = nwnrs_set::SetFile::from_file;

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

Reads a typed SET file from a Res.

Errors

Returns SetError if the resource is not a SET type or the bytes cannot be parsed.

Examples

let _ = nwnrs_set::SetFile::from_res;

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

Reads a typed SET file from a ResMan by tileset name.

Examples

let _ = nwnrs_set::SetFile::from_resman;

Trait Implementations

impl Clone for SetFile

fn clone(&self) -> SetFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetFile

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

Formats the value using the given formatter.

impl Default for SetFile

fn default() -> SetFile

Returns the “default value” for a type.

impl PartialEq for SetFile

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