Struct ForcePlan 

pub struct ForcePlan<'a> { /* private fields */ }

Characters and forces of the world, in startpos order.

Implementations

impl<'a> ForcePlan<'a>

pub fn characters(&self) -> &Vec<PlannedCharacter<'a>>

Characters, in id order.

pub fn forces(&self) -> &Vec<PlannedForce<'a>>

Forces, in id order.

impl<'a> ForcePlan<'a>

pub fn new( tables: &StartposTables, index: &'a CampaignIndex, plan: &WorldPlan<'a>, ) -> Result<Self>

Plans the characters and forces of a world.

Arguments

• tables - Tables of the game and the campaign.
• index - The campaign’s startpos rows.
• plan - Order of the factions and regions.

Errors

Returns an error if a table or column is missing.

pub fn character_positions(&self, faction: &str) -> Vec<usize>

Returns the positions in the plan of the characters of a faction, in startpos order: its own, then the ones moved to it.

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

Returns the characters of a faction, in startpos order: its own, then the ones moved to it.

pub fn forces_of( &self, faction: &str, ) -> impl Iterator<Item = &PlannedForce<'a>>

Returns the forces of a faction, in startpos order: its own, then the ones moved to it.

pub fn stationed_in(&self, region: &str) -> Option<&PlannedForce<'a>>

Returns the first general’s army starting in a region’s settlement, if any.

pub fn garrison_of( &self, region: &str, kind: ForceKind, ) -> Option<&PlannedForce<'a>>

Returns the garrison force of a kind defending a region, if any.

Trait Implementations

impl<'a> Clone for ForcePlan<'a>

fn clone(&self) -> ForcePlan<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ForcePlan<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ForcePlan<'a>

fn default() -> ForcePlan<'a>

Returns the “default value” for a type.