Struct Archive 

pub struct Archive {
    pub user_packs: usize,
    /* private fields */
}

A set of packages resolved by priority: higher priority shadows lower for the same name.

Fields

user_packs: usize

IO::FileSystem: the user pack files (enabled mods) the packages were set up with (AddUserPackFile, AreUserPackFilesEnabled).

Implementations

impl Archive

pub fn add(&mut self, pkg: Package)

Add one of the game’s packages. An entry replaces one of the same name when its package’s priority is not lower.

pub fn add_mod(&mut self, pkg: Package)

FileSystem::LoadPackages for a mod (.pkm), added after the game’s packages: the enabled mods go in from the last in the mod list to the first, and a file replaces one already there only when that one’s package allows it. So the first mod in the list wins, and nothing overrides data1 or patch1.

Original: Runtime 0x1800ac3b0.

pub fn package_count(&self) -> usize

How many packages are loaded (the game’s first, then the mods).

pub fn remove_after(&mut self, keep: usize)

Drop every package after the first keep (the mods), as FileSystem::ClosePackages before the packages load again.

pub fn package_of(&self, name: &str) -> Option<&Package>

The package holding name’s current entry (its header names the mod).

pub fn len(&self) -> usize

The number of entries.

pub fn is_empty(&self) -> bool

Whether there are no entries.

pub fn names(&self) -> Vec<&str>

Resource names, sorted.

pub fn get(&self, name: &str) -> Option<&Entry>

An entry by name.

pub fn read(&self, name: &str) -> Result<Vec<u8>>

An entry’s bytes, expanded, by entry name (for example Dialog\Toolbar_resource.crs).

pub fn read_ref(&self, reference: &str) -> Result<Vec<u8>>

Read the compiled resource behind a reference such as Models\X\Y.rsc:resource. The package stores it as Models\X\Y_resource.crs.

Trait Implementations

impl Default for Archive

fn default() -> Archive

Returns the “default value” for a type.