Character

Struct Character 

Source
pub struct Character {
Show 15 fields pub classes: Classes, pub name: String, pub age: u16, pub race_index: String, pub subrace_index: String, pub alignment_index: String, pub description: String, pub background_index: String, pub background_description: String, pub money: u32, pub abilities_score: Arc<Mutex<Abilities>>, pub hp: u16, pub hit_dice_result: u16, pub inventory: HashMap<String, u16>, pub other: Vec<String>, /* private fields */
}

Fields§

§classes: Classes

Indexes from https://www.dnd5eapi.co/api/classes/

§name: String§age: u16§race_index: String

Index from https://www.dnd5eapi.co/api/races/

§subrace_index: String

Index from https://www.dnd5eapi.co/api/subraces/

§alignment_index: String

Index from https://www.dnd5eapi.co/api/alignments/

§description: String

Physical description

§background_index: String

Index from https://www.dnd5eapi.co/api/backgrounds/

§background_description: String

Background description

§money: u32§abilities_score: Arc<Mutex<Abilities>>§hp: u16§hit_dice_result: u16§inventory: HashMap<String, u16>§other: Vec<String>

Implementations§

Source§

impl Character

Source

pub async fn get_base_speed(&self) -> Result<i32, ApiError>

Source§

impl Character

Source

pub async fn get_spellcasting_slots( &self, ) -> Result<HashMap<String, LevelSpellcasting>, ApiError>

Source

pub async fn get_features(&self, passive: bool) -> Result<Vec<String>, ApiError>

Source

pub async fn rich_data(&self) -> Result<Value, ApiError>

Source

pub async fn new_day(&mut self)

Call this method every day to reset daily vars

Source§

impl Character

Source

pub fn new( main_class: String, name: String, age: u16, race_index: String, subrace_index: String, alignment_index: String, description: String, background_index: String, background_description: String, ) -> Self

Source

pub fn class_armor(&self) -> i8

Source

pub fn level(&self) -> u8

Return current level of the character

Source

pub fn experience_points(&self) -> u32

Returns the experience points of the character

Source

pub fn add_experience(&mut self, experience: u32) -> u8

Returns the number of levels the character has earned this means that you should add the returned value to a class level (this must be done manually to permit multiclassing)

§Arguments
  • experience - The experience points to add to the character
Source

pub fn remove_item( &mut self, item: &str, amount: Option<u16>, ) -> Result<(), Error>

Source

pub fn add_item(&mut self, item: &str, amount: u16)

Source

pub fn alter_item_quantity(&mut self, item: &str, amount: i32) -> Result<()>

Source

pub fn max_hp(&self) -> u16

Calculate the maximum HP of the character based on constitution modifier and hit dice result

Trait Implementations§

Source§

impl Debug for Character

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Character

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Character

Source§

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

Serialize this value into the given Serde serializer. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> IsFieldType<T> for T