Struct Character

pub struct Character {

    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: Abilities,
    pub hp: u16,
    pub max_hp: 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: Abilities

hp: u16

max_hp: u16

inventory: HashMap<String, u16>

other: Vec<String>

Implementations

impl Character

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

impl Character

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

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

pub async fn rich_print(&self) -> Result<String, ApiError>

pub async fn new_day(&mut self)

Call this method every day to reset daily vars

impl Character

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

pub fn class_armor(&self) -> i8

pub fn level(&self) -> u8

Return current level of the character

pub fn experience_points(&self) -> u32

Returns the experience points of the character

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

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

Trait Implementations

impl Debug for Character

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Character

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

where __S: Serializer,

Serialize this value into the given Serde serializer.