Struct CampaignIndex 

pub struct CampaignIndex { /* private fields */ }

The start_pos_* rows of one campaign, with their references resolved to keys.

Implementations

impl CampaignIndex

pub fn campaign(&self) -> &String

Campaign key.

pub fn factions(&self) -> &Vec<FactionEntry>

Factions of the campaign, in start_pos_factions order.

pub fn regions(&self) -> &Vec<RegionEntry>

Regions of the campaign, in start_pos_regions order.

pub fn settlements(&self) -> &Vec<SettlementEntry>

Settlements of the campaign’s regions, in start_pos_settlements order.

pub fn characters(&self) -> &Vec<CharacterEntry>

Characters of the campaign’s factions, in start_pos_characters order.

impl CampaignIndex

pub fn new(tables: &StartposTables, campaign: &str) -> Result<Self>

Indexes the startpos rows of a campaign.

Arguments

• tables - Tables with start_pos_factions, start_pos_regions, start_pos_settlements, start_pos_characters, factions and cultures_subcultures.
• campaign - Campaign key.

Errors

Returns an error if a table or column is missing, or a faction lacks its factions row.

pub fn faction(&self, key: &str) -> Option<&FactionEntry>

Returns a faction by key.

pub fn faction_by_id(&self, id: &str) -> Option<&FactionEntry>

Returns a faction by its start_pos_factions row id.

pub fn region(&self, key: &str) -> Option<&RegionEntry>

Returns a region by key.

pub fn regions_of<'a>( &'a self, faction: &'a str, ) -> impl Iterator<Item = &'a RegionEntry> + 'a

Returns the regions owned by a faction, in table order.

pub fn capital_of<'a>(&'a self, faction: &'a str) -> Option<&'a RegionEntry>

Returns the capital of a faction: the first of its regions flagged as capital, in table order.

pub fn settlement_of(&self, region: &str) -> Option<&SettlementEntry>

Returns the settlement of a region.

pub fn characters_of<'a>( &'a self, faction: &'a str, ) -> impl Iterator<Item = &'a CharacterEntry> + 'a

Returns the characters of a faction, in table order.

pub fn factions_in_startpos_order(&self) -> Vec<&FactionEntry>

Returns the factions in startpos order: playable factions first, each group by starting_order.

The game sorts with an unstable sort, so factions with the same starting order may come out in another order in game-built startposes.

Trait Implementations

impl Clone for CampaignIndex

fn clone(&self) -> CampaignIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CampaignIndex

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

Formats the value using the given formatter.

impl Default for CampaignIndex

fn default() -> CampaignIndex

Returns the “default value” for a type.