Struct GameLayouts 

pub struct GameLayouts { /* private fields */ }

Record layouts of a game: one per campaign the game has a startpos for, and one merged from all of them.

Implementations

impl GameLayouts

pub fn load_or_extract( layouts_folder: &Path, game: &GameInfo, game_data_path: &Path, ) -> Result<Self>

Loads the layouts of a game, extracting them from the game’s startposes if they aren’t cached or one of the startposes is newer than the cache (like after a patch, or a new campaign).

Arguments

• layouts_folder - Folder with the cached layouts.
• game - The game.
• game_data_path - The game’s data folder, with campaigns/<campaign>/startpos.esf.

Errors

Returns an error if the game has no startpos to take the layouts from, or one can’t be decoded or cached.

pub fn for_campaign( &self, tables: &StartposTables, campaign: &str, ) -> StartposLayout

Returns the layout to write a campaign’s startpos with: the campaign’s own if the game has its startpos, otherwise the one of a game campaign on the same map, otherwise the merged one. The campaign’s or map’s layout takes the records it lacks from the merged one.

Arguments

• tables - Tables with campaigns, to find the campaigns on the same map.
• campaign - Campaign key.

Trait Implementations

impl Clone for GameLayouts

fn clone(&self) -> GameLayouts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GameLayouts

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

Formats the value using the given formatter.