Skip to main content

Character

proof_engine::character

Struct Character 

Source 
pub struct Character {
Show 30 fields
    pub id: CharacterId,
    pub name: String,
    pub kind: CharacterKind,
    pub state: CharacterState,
    pub archetype: ClassArchetype,
    pub stats: StatSheet,
    pub resources: AllResources,
    pub level_data: LevelData,
    pub modifier_registry: ModifierRegistry,
    pub stat_growth: StatGrowth,
    pub equipped: EquippedItems,
    pub inventory: Inventory,
    pub stash: Stash,
    pub gold: u64,
    pub skill_book: SkillBook,
    pub ability_bar: AbilityBar,
    pub cooldowns: CooldownTracker,
    pub combos: ComboSystem,
    pub journal: QuestJournal,
    pub achievements: AchievementSystem,
    pub quest_tracker: QuestTracker,
    pub faction: Option<String>,
    pub faction_system: FactionSystem,
    pub controller: CharacterController,
    pub input_binding: InputBinding,
    pub appearance: AppearanceData,
    pub is_player_controlled: bool,
    pub event_queue: Vec<CharacterEvent>,
    pub tags: Vec<String>,
    pub metadata: HashMap<String, String>,

}

Fields§

§id: CharacterId§name: String§kind: CharacterKind§state: CharacterState§archetype: ClassArchetype§stats: StatSheet§resources: AllResources§level_data: LevelData§modifier_registry: ModifierRegistry§stat_growth: StatGrowth§equipped: EquippedItems§inventory: Inventory§stash: Stash§gold: u64§skill_book: SkillBook§ability_bar: AbilityBar§cooldowns: CooldownTracker§combos: ComboSystem§journal: QuestJournal§achievements: AchievementSystem§quest_tracker: QuestTracker§faction: Option<String>§faction_system: FactionSystem§controller: CharacterController§input_binding: InputBinding§appearance: AppearanceData§is_player_controlled: bool§event_queue: Vec<CharacterEvent>§tags: Vec<String>§metadata: HashMap<String, String>

Implementations§

Source§

impl Character

Source

pub fn new( id: CharacterId, name: impl Into<String>, kind: CharacterKind, archetype: ClassArchetype, ) -> Self

Source

pub fn tick(&mut self, dt: f32)

Tick all time-dependent subsystems by dt seconds.

Source

pub fn set_state(&mut self, new_state: CharacterState)

Source

pub fn take_damage(&mut self, amount: f32, source: &str) -> bool

Deal damage to this character. Returns true if the character died.

Source

pub fn heal(&mut self, amount: f32) -> f32

Heal this character.

Source

pub fn gain_xp(&mut self, amount: u64)

Gain experience, potentially levelling up.

Source

pub fn change_reputation(&mut self, faction: &str, delta: i32)

Modify reputation with a faction.

Source

pub fn level(&self) -> u32

Get current level.

Source

pub fn is_alive(&self) -> bool

Whether this character is alive.

Source

pub fn drain_events(&mut self) -> Vec<CharacterEvent>

Drain pending events.

Source

pub fn add_tag(&mut self, tag: impl Into<String>)

Source

pub fn has_tag(&self, tag: &str) -> bool

Source

pub fn set_meta(&mut self, key: impl Into<String>, value: impl Into<String>)

Source

pub fn get_meta(&self, key: &str) -> Option<&str>

Trait Implementations§

Source§

impl Clone for Character

Source§

fn clone(&self) -> Character

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Character

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,