Struct EventFlags 

#[non_exhaustive]
pub struct EventFlags { /* private fields */ }

A generic, string-keyed event flag system.

Stores boolean flags keyed by string name. This is the foundation for game-event tracking (story progression, item pickups, trainer defeats) in any JRPG. The struct is #[non_exhaustive] to allow game-specific extensions in downstream crates.

Design

• Flags are stored as HashMap<String, bool> — one entry per flag name.
• The string API (get_flag, set_flag, remove_flag) works with any flag name, enabling game-specific typed wrappers.
• All methods are pure data manipulation — no I/O, no platform code.

Example

let mut flags = EventFlags::new();
flags.set_flag("player_has_sword", true);
assert!(flags.get_flag("player_has_sword"));

Implementations

impl EventFlags

pub fn new() -> Self

Creates a new EventFlags with no flags set.

pub fn count_set(&self) -> u32

Returns the number of flags that are currently set to true.

pub fn clear_all(&mut self)

Clears all flags.

pub fn get_flag(&self, name: &str) -> bool

Returns the value of a named flag, or false if unset.

pub fn set_flag(&mut self, name: &str, value: bool)

Sets a named flag to a specific value.

pub fn remove_flag(&mut self, name: &str)

Removes a named flag entirely.

pub fn iter(&self) -> impl Iterator<Item = (&String, &bool)>

Returns an iterator over all (name, value) pairs.

pub fn as_hashmap(&self) -> &HashMap<String, bool>

Returns a shared reference to the underlying HashMap.

pub fn as_hashmap_mut(&mut self) -> &mut HashMap<String, bool>

Returns a mutable reference to the underlying HashMap.

pub fn merge_from(&mut self, other: &HashMap<String, bool>)

Merges entries from another HashMap into this flag set. Existing keys are overwritten.

pub fn to_hashmap(&self) -> HashMap<String, bool>

Clones the underlying HashMap for external use.

pub fn from_hashmap(map: &HashMap<String, bool>) -> Self

Creates an EventFlags from an existing HashMap.

Trait Implementations

impl Clone for EventFlags

fn clone(&self) -> EventFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventFlags

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

Formats the value using the given formatter.

impl Default for EventFlags

fn default() -> Self

Returns the “default value” for a type.