Struct EpochInfo 

pub struct EpochInfo {
    pub epoch_id: EpochId,
    pub rng_seed: u64,
    pub tags: TagList,
    pub summary: String,
    pub events: Vec<Entity>,
    pub characters: Vec<Entity>,
    pub towns: Vec<Entity>,
    pub calamities: Vec<Entity>,
    pub blockers: Vec<Entity>,
}

The metadata file stored inside each epoch directory (epoch/<epoch_id>/.epochinfo).

It contains only the information that is needed for the engine to reconstruct the state of that particular epoch (seed, selected events, parent link, etc.). The full world data will be kept in separate storage (e.g. world.json) but is for stored here.

Fields

epoch_id: EpochId

The ID of this epoch - should match the directory name.

rng_seed: u64

RNG seed that was used to generate randomised data for this epoch. Keeping it in the file guarantees repeatable behaviour when replaying the same epoch.

tags: TagList

Optional tags that help identify the epoch (e.g. "Winter-B").

summary: String

Human-readable description or summary, useful for the log command.

events: Vec<Entity>

The list of events currently in progress

characters: Vec<Entity>

The list of characters currently present

towns: Vec<Entity>

The list of towns currently present

calamities: Vec<Entity>

The list of calamities currently present

blockers: Vec<Entity>

The list of blockers currently present

Implementations

impl EpochInfo

pub fn create_subfolders(&self) -> Result<(), EpochError>

Create all subfolders as needed

This command can be safely used even if the folder already exists

impl EpochInfo

pub fn find_entity_of_type( &self, entity_to_find: &Option<EntityIdentifier>, e_type: &EntityType, ) -> Result<&Entity, EpochError>

Looks up an entity inside the given epoch_info according to the supplied arguments.

The function returns a reference to the matching entity or an EpochError::EntityNotFound if no entity matches.

Arguments

• entity_args - The arguments that identify the entity.
• e_type - The type of entity to look for.
• epoch_info - The epoch that contains all entities.

Returns

• Ok(&Entity) - The entity that matches the arguments.
• Err(EpochError::EntityNotFound) - No matching entity was found.

pub fn add_to_links( &mut self, target_id: Uuid, target_t: &EntityType, link_back: TypedLink, ) -> Result<(), EpochError>

Adds a link between two entities inside the epoch.

The link is added to the entity identified by id_to_add_to. If the target entity is not found, an EntityNotFoundById error is returned.

pub fn del_from_links( &mut self, target_id: Uuid, target_t: &EntityType, link_back: TypedLink, ) -> Result<(), EpochError>

Removes a link from an entity inside the epoch.

The removal is performed on the target entity (id_to_add_to). If the target entity cannot be found, an EpochError::EntityNotFoundById error is returned. The removal itself is delegated to the entity’s del_from_links method, which silently ignores missing links.

pub fn find_any_entity( &self, id: EntityIdentifier, ) -> Result<&Entity, EpochError>

Find an entity by its UUID.

This function searches the currently loaded epoch for an entity whose id matches the supplied Uuid. It looks in both the events, towns and characters collections of the epoch.

Arguments

• id - The Uuid of the entity to locate.

Returns

• Ok(&Entity) - Reference to the entity if it is present in the current epoch.
• Err(EpochError::EntityNotFoundById(id)) - No entity with the supplied UUID exists in the epoch.

pub fn find_entity_strict( &self, id: Uuid, strict: Option<EntityType>, ) -> Result<&Entity, EpochError>

Find an entity from an Uuid

pub fn find_entity_strict_as_mut( &mut self, id: Uuid, strict: Option<EntityType>, ) -> Result<&mut Entity, EpochError>

Find an entity from an Uuid

pub fn vec_entities(&self, e_type: &EntityType) -> &Vec<Entity>

Returns a slice over the entities of the requested type from the given EpochInfo.

The function matches the supplied e_type to the appropriate collection inside epoch_info. For unimplemented entity types the call will panic because of the todo!() placeholder.

pub fn remove_entity( &mut self, entity_identifier: &Option<EntityIdentifier>, e_type: &EntityType, ) -> Result<Entity, EpochError>

Removes an entity from the epoch’s collection and returns it.

The function looks up the entity that matches the supplied entity_identifier in the collection corresponding to e_type. If the entity is found, it is removed using swap_remove and returned. When the entity cannot be located, an EpochError::EntityNotFound is returned.

pub fn vec_entities_mut(&mut self, e_type: &EntityType) -> &mut Vec<Entity>

Returns a mutable slice over the entities of the requested type from the given EpochInfo.

Like vec_entities, this function selects the appropriate collection based on e_type. Unimplemented variants will panic due to the todo!().

pub fn iter_all_entities_mut(&mut self) -> impl Iterator<Item = &mut Entity>

Returns an iterator over mutable references to all entities that are currently stored in the EpochInfo container.

pub fn resolve_position( &self, position: &PositionIdentifier, ) -> Result<Position, EpochError>

Get the position of an entity either directly or cloning one from an epoch

pub fn swap_entity(&mut self, entity: Entity) -> Result<Entity, EpochError>

Swap an entity with an updated one

Trait Implementations

impl Clone for EpochInfo

fn clone(&self) -> EpochInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigWritable for EpochInfo

fn save_path(&self) -> String

The full path indicating where to save the config

fn save_folder(&self) -> String

The folder where to save the file to save the config

fn as_json(&self, action: String) -> Result<String, EpochError>

Serialises the config into a pretty JSON string.

fn save_with_context( &self, action_description: &str, do_not_erase: &SaveMode, ) -> Result<(), EpochError>

Saves the config into its nominal path.

impl Debug for EpochInfo

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

Formats the value using the given formatter.

impl Default for EpochInfo

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EpochInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EpochInfo

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

Formats the value using the given formatter.

impl Prettiable for EpochInfo

fn as_table(list: Vec<&Self>) -> Result<TableDisplay, EpochError>

where for<'a> Vec<&'a Self>: Table + WithTitle,

Shows many items as a table.

fn show_as_log(&self)

Displays the struct as a log entry by printing the output of as_log() to stdout.

fn as_log(&self) -> String

Converts the struct into a pretty log string.

impl Row for &EpochInfo

fn row(self) -> RowStruct

Converts raw type to rows of a table

impl Row for EpochInfo

fn row(self) -> RowStruct

Converts raw type to rows of a table

impl Serialize for EpochInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Title for EpochInfo

fn title() -> RowStruct

Returns title row of a struct