Struct CharacterSheet 

pub struct CharacterSheet {

    pub name: String,
    pub player_name: Option<String>,
    pub race: String,
    pub background: String,
    pub alignment: String,
    pub classes: Vec<ClassLevel>,
    pub experience_points: u32,
    pub ability_scores: AbilityScores,
    pub hit_points: HitPoints,
    pub armor_class: u8,
    pub speed: u16,
    pub saving_throw_proficiencies: Vec<Ability>,
    pub skill_proficiencies: Vec<Skill>,
    pub inventory: Vec<Item>,
    pub spellcasting: Spellcasting,
    pub resources: Vec<Resource>,
    pub notes: String,
}

The editable contents of a character sheet. This is the request body for both creating and replacing a character.

Fields

name: String

player_name: Option<String>

race: String

background: String

alignment: String

classes: Vec<ClassLevel>

experience_points: u32

ability_scores: AbilityScores

hit_points: HitPoints

armor_class: u8

speed: u16

saving_throw_proficiencies: Vec<Ability>

skill_proficiencies: Vec<Skill>

inventory: Vec<Item>

spellcasting: Spellcasting

resources: Vec<Resource>

Limited-use class features and abilities (Action Surge, Rage, Ki…).

notes: String

Implementations

impl CharacterSheet

pub fn apply(&mut self, action: &CharacterAction) -> Result<(), ActionError>

Applies an action. On error the sheet is left unchanged.

pub fn rest(&mut self, kind: RestKind)

Takes a rest: restores what recovers on it (and, on a long rest, all hit points).

impl CharacterSheet

pub const MAX_LEVEL: u8 = 20

The highest total character level.

pub fn total_level(&self) -> u8

Sum of all class levels (at least 1 for display purposes when empty).

pub fn proficiency_bonus(&self) -> i8

The proficiency bonus for the character’s total level.

pub fn saving_throw(&self, ability: Ability) -> i8

The bonus to a saving throw: the ability’s modifier, plus proficiency if proficient.

pub fn skill_bonus(&self, skill: Skill) -> i8

The bonus to a skill check: its ability’s modifier, plus proficiency if proficient.

pub fn spell_save_dc(&self, ability: Ability) -> i8

The spell save DC when casting with ability: 8 + proficiency + modifier.

pub fn spell_attack_bonus(&self, ability: Ability) -> i8

The spell attack bonus when casting with ability: proficiency + modifier.

pub fn validate(&self) -> Result<(), ValidationError>

Validates rules that serde can’t express. Shared by server and clients so frontends can give immediate feedback.

impl CharacterSheet

pub fn derive_slots(&mut self, edition: Edition)

Sets the spell slots (and Pact Magic) the classes give, under the campaign’s edition. Slots already spent stay spent, up to the new number.

Trait Implementations

impl Clone for CharacterSheet

fn clone(&self) -> CharacterSheet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for CharacterSheet

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for CharacterSheet

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

Formats the value using the given formatter.

impl Default for CharacterSheet

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CharacterSheet

where CharacterSheet: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CharacterSheet

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

Tests for self and other values to be equal, and is used by ==.

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 CharacterSheet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for CharacterSheet

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl StructuralPartialEq for CharacterSheet