Struct Entity 

pub struct Entity {
    pub name: String,
    pub description: String,
    pub id: Uuid,
    pub entity_type: EntityType,
    /* private fields */
}

An entity that can be present in the game world.

Entities are mutable only through the entity system’s public API. Their fields are private to prevent accidental state corruption.

Fields

name: String

The name of the entity

description: String

A short description of the entity

id: Uuid

The global identifier for the entity

entity_type: EntityType

The categorical type of the entity.

Currently an enum that distinguishes creatures, items, terrain, etc. It will be phased out in favor of a trait-based system for greater type safety.

Implementations

impl Entity

pub fn change_stat_strict(&mut self, pair: StatPair, delta: Modification)

Change one of the entity’s statistics.

The stat identified by pair is replaced with the new value specified in the StatPair. This is a direct overwrite and does not apply any delta.

Arguments

• pair - The stat pair containing the key and new value.

pub fn change_stat_fuzzy(&mut self, pair: StatPair, delta: Modification)

Mutate a statistic in a “fuzzy” way.

This method behaves like change_stat_strict for ordinary stats, but for meta-stats it applies a random modification instead of an outright overwrite.

Parameters

• pair - a StatPair that contains the target statistic and the value that should be used for the fuzzy change.

pub fn change_duration(&mut self, duration: EntityDuration)

Change the entity’s duration.

This simply replaces the current EntityDuration with the one supplied. No validation or transformation is performed; it is a direct overwrite.

Arguments

• duration - The new EntityDuration to assign to the entity.

pub fn change_description(&mut self, descritption: String)

Change the entity’s description.

Replaces the current description string with the new one supplied.
This method performs a direct overwrite; the previous description is dropped.

Arguments

• descritption - The new description string for the entity.

pub fn delta_stat(&mut self, pair: StatPair)

👎Deprecated

Apply a delta to all of the entity’s statistics.

The delta specified by pair is added to each of the statistics in self.stats. Positive values increase the stat, negative values decrease it.

Arguments

• pair - The stat pair representing the change to apply.

pub fn modify_duration(&mut self, duration: EntityDuration)

Replace the entity’s duration.

The method simply overwrites the current duration field with the supplied value. It is primarily intended for use when an entity is instantiated from external data that already contains a duration value.

pub fn modify_effect_application(&mut self, effect: EffectApplication)

Set the way the entity’s effects are applied.

The field effect_nature determines how the entity’s abilities or status effects interact with the world. This method overwrites the existing value with the supplied EffectApplication.

pub fn modify_effect_bounds(&mut self, effect: EffectBounds)

Update the bounds that govern the entity’s effects.

effect_bounds controls the maximum/minimum strength, duration or other limits that can be applied to the entity’s effects. This method simply replaces the current bounds with the supplied EffectBounds.

pub fn modify_position(&mut self, pos: Position)

Sets the entity’s position using a world-space Position.

This method updates the internal metadata to the specified world coordinates.

pub fn modify_faction(&mut self, faction: Option<FactionId>)

Sets the entity’s faction identifier.

This method updates the internal metadata to reflect the provided faction. A None value indicates that the entity is not affiliated with any faction.

pub fn modify_reach(&mut self, reach: Reach)

Sets the entity’s reach description.

The reach string typically contains information such as the distance or area the entity can affect. This method replaces the current reach value stored in the entity’s metadata.

pub fn modify_position_grid(&mut self, pos: PositionGrid)

Sets the entity’s position using a grid-space PositionGrid.

The supplied grid coordinates are converted to world space before being stored.

pub fn modify_description(&mut self, descritption: String)

Changes the entity’s description text.

pub fn modify_prestige(&mut self, prestige: GenericStat, delta: Modification)

Sets the entity’s prestige stat to an absolute value.

The prestige value is stored directly in the entity’s metadata and overwrites any previous value.

pub fn change_governor(&mut self, governor: CharacterId) -> Option<CharacterId>

Add a governor to the entity if the id exists and return the old governor if it existed

pub fn remove_governor(&mut self) -> Option<CharacterId>

Remove the entity’s governor and return it

pub fn change_capital(&mut self, capital: TownId) -> Option<TownId>

Add a governor to the entity if the id exists

pub fn remove_capital(&mut self) -> Option<TownId>

Remove the entity’s governor and return it

pub fn position(&self) -> &Position

Returns a read-only reference to the entity’s current position.

pub fn update_metastats(&mut self)

Defer the update of all stats

pub fn match_identifier( &self, entity_identifier: &Option<EntityIdentifier>, ) -> bool

Returns whether the entity match an optionnal identifier

impl Entity

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

The table contains both the permanent and temporary statistics of the entity. The table is formatted with a custom border and separator using the cli_table crate.

Returns

A Result containing the table display on success, or an EpochError if the conversion to a table string fails.

pub fn add_to_links(&mut self, id_to_add: TypedLink)

Adds a link (UUID) to the entity’s metadata.

If id_to_add is already present in the links vector, this method does nothing - it silently ignores duplicates. The method is idempotent: calling it repeatedly with the same UUID will not change the underlying state.

pub fn del_from_links(&mut self, id_to_remove: TypedLink) -> Option<TypedLink>

Removes a link (UUID) from the entity’s metadata.

If the supplied id_to_remove exists in self.metadata.links, it is removed and returned wrapped in Some. If the UUID is not present, the method returns None and leaves the link list unchanged.

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

Display the entity’s statistics in a pretty table (same format as full_stats_to_table).

This method is provided for backward compatibility and forwards all work to full_stats_to_table.

Returns

A Result containing the table display on success, or an EpochError if the conversion to a table string fails.

pub fn reset_temporary_stats_to(&mut self, other: Option<OverallStats>)

Reset the temporary stats to a given base value.

Useful before performing an update: you can set the temporary stats to whatever snapshot you want to start from (or None to clear it).

pub fn get_stats(&self) -> &OverallStats

Return an immutable reference to the entity’s live statistics.

pub fn get_temp_stats(&self) -> &Option<OverallStats>

Return an immutable reference to the temporary statistics snapshot, if one is currently stored.

pub fn to_pretty_tree(&self, epoch_info: &EpochInfo) -> String

Pretty-print the entity as a coloured tree.

The output is a String that visualises the entity’s metadata, type, duration, effect bounds, and any links. Colours are applied using colored::Colorize.

Returns

A String containing the formatted tree.

pub fn create_rng( e_type: &EntityType, rng: &RngLevel, ) -> Result<Self, EpochError>

Create an entity using a specific RNG level.

The entity is initialised with random statistics, a random position, and a random prestige value derived from the supplied RngLevel.

Arguments

• e_type - The type of entity to create.
• rng - The RNG level to use when generating random values.

Returns

• Ok(Self) - The newly created entity.
• Err(EpochError) - Propagated from any randomisation failure.

impl Entity

pub fn remove_all_links( &self, epoch_info: &mut EpochInfo, ) -> Result<(), EpochError>

Iterate over all the links and do the appropriate action

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Entity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Entity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Diffable for Entity

fn delta(&self, other: &Self) -> Self

Compare self with another struct of the same type and return a new instance containing the difference

impl Displayable for Entity

fn oneline_display(&self) -> String

One-liner used for auto-generation of Vec<T> displays

fn print_full(&self, epoch_info: &EpochInfo)

Return a fully-described string representation.

fn short_display(&self, _epoch_info: &EpochInfo) -> String

Return a short, user-friendly string. Resolves Ids

impl Hash for Entity

fn hash<H: Hasher>(&self, state: &mut H)

Massive speedup at the cost of collision on updates, making eq for finding but not true equality However a .deep_eq() should be used for this

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Entity

fn eq(&self, other: &Self) -> bool

Time save and clash if not .deep_eq

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Entity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Symbols for Entity

fn to_symbol(&self) -> String

Have a small Symbol to resume it

fn to_shortest(&self) -> String

Have the shortest display possible