Struct WorldPlan 

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

Order and runtime ids of the objects of the world.

Implementations

impl<'a> WorldPlan<'a>

pub fn new(index: &'a CampaignIndex) -> Self

Plans the world of a campaign: factions in startpos order, regions in table order.

pub fn with_orders( factions: Vec<&'a FactionEntry>, regions: Vec<&'a RegionEntry>, ) -> Self

Plans the world of a campaign with the given object orders, for example the ones of a game-built startpos.

Arguments

• factions - Factions, in the order of their runtime ids.
• regions - Regions, in the order of their runtime ids.

pub fn set_character_order( &mut self, faction: &str, characters: Vec<&'a CharacterEntry>, )

Sets the order of a faction’s living characters, for example the one of a game-built startpos. Living characters left out of it go after it, in table order.

Arguments

• faction - Faction key.
• characters - The faction’s characters, in the order of their runtime ids.

pub fn character_order(&self, faction: &str) -> Option<&[&'a CharacterEntry]>

Returns the order set for a faction’s living characters, if any.

pub fn factions(&self) -> &[&'a FactionEntry]

Returns the factions, in startpos order.

pub fn regions(&self) -> &[&'a RegionEntry]

Returns the regions, in startpos order.

pub fn region_id(&self, region: &str) -> Option<u32>

Returns the runtime id of a region.

pub fn faction_id(&self, faction: &str) -> Option<u32>

Returns the runtime id of a faction.

Trait Implementations

impl<'a> Clone for WorldPlan<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WorldPlan<'a>

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

Formats the value using the given formatter.

impl<'a> Default for WorldPlan<'a>

fn default() -> WorldPlan<'a>

Returns the “default value” for a type.