Struct Combatant 

pub struct Combatant {
    pub id: Uuid,
    pub name: String,
    pub character_id: Option<Uuid>,
    pub monster_id: Option<Uuid>,
    pub initiative_modifier: i8,
    pub initiative: Option<i16>,
    pub hit_points: HitPoints,
    pub armor_class: Option<u8>,
    pub concealed: bool,
}

Anyone in a combat: a character, a monster, or anyone else the DM adds.

Fields

id: Uuid

Chosen by the client that adds the combatant, so it can predict the outcome exactly. The server rejects duplicates.

name: String

character_id: Option<Uuid>

Set when this combatant is a character from the character service.

monster_id: Option<Uuid>

Set when this combatant is a monster from the monster service, so its stat block can be shown.

initiative_modifier: i8

initiative: Option<i16>

Initiative total. None until rolled or set.

hit_points: HitPoints

While Self::concealed, only how hurt it looks: see Vitality.

armor_class: Option<u8>

concealed: bool

Its hit points and armor class are behind the DM’s screen: a player’s device sees monsters like this (see view).

Implementations

impl Combatant

pub fn new(name: impl Into<String>, max_hp: u16) -> Self

A combatant at full hit points, with no initiative yet.

pub fn from_character(character: &Character) -> Self

A combatant for a character sheet, using its current HP, AC and Dexterity modifier.

pub fn from_monster(monster: &Monster, name: String, hit_points: u16) -> Self

A combatant for a monster, called name (e.g. “Goblin 2”), with hit_points (its maximum, or rolled).

pub fn is_down(&self) -> bool

Whether it’s at 0 hit points.

pub fn vitality(&self) -> Vitality

How hurt it looks, concealed or not.

Trait Implementations

impl Clone for Combatant

fn clone(&self) -> Combatant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Combatant

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

impl Debug for Combatant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Combatant

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Combatant

fn eq(&self, other: &Combatant) -> 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 Combatant

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 Combatant

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 Eq for Combatant

impl StructuralPartialEq for Combatant