Struct sulis_state::script::script_callback::ScriptHitKind

pub struct ScriptHitKind {
    pub kind: HitKind,
    pub total_damage: u32,
    // some fields omitted
}

ScriptHitKind stores the result of an attack for lua. Includes the hit kind and any damage.

is_miss() -> Bool

Whether the attack was a miss

is_graze() -> Bool

Whether the attack was a graze

is_hit() -> Bool

Whether the attack was a hit

is_crit() -> Bool

Whether the attack was a crit

total_damage() -> Int

The total damage (in hit points) that the attack did.

damage_of_type(type: String) -> Int

Returns the total damage (in hit points) from this attack for the given damage type

entries() -> Table

Creates a table of damage entries in this hit. Iterating over the table will allow you to access each damage type and corresponding amount.

Examples

  entries = hit:entries()
  for i = 1, #entries do
    game:log("Type: " .. entries[i]:type() .. ", amount: " .. tostring(entries[i]:amount()))
  end

kind() -> String

The type of hit. One of Miss, Graze, Hit, or Crit.

Fields

kind: HitKind

total_damage: u32

Implementations

impl ScriptHitKind

pub fn new(kind: HitKind, damage: Vec<(DamageKind, u32)>) -> ScriptHitKind

Trait Implementations

impl Clone for ScriptHitKind

fn clone(&self) -> ScriptHitKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl UserData for ScriptHitKind

fn add_methods<'lua, M: UserDataMethods<'lua, Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.