[][src]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.


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

kind() -> String

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


kind: HitKindtotal_damage: u32


impl ScriptHitKind[src]

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

Trait Implementations

impl Clone for ScriptHitKind[src]

impl UserData for ScriptHitKind[src]

Auto Trait Implementations

impl RefUnwindSafe for ScriptHitKind

impl Send for ScriptHitKind

impl Sync for ScriptHitKind

impl Unpin for ScriptHitKind

impl UnwindSafe for ScriptHitKind

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<'lua, T> FromLua<'lua> for T where
    T: 'static + UserData + Clone

impl<'lua, T> FromLuaMulti<'lua> for T where
    T: FromLua<'lua>, 

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<'lua, T> ToLua<'lua> for T where
    T: 'static + UserData + Send

impl<'lua, T> ToLuaMulti<'lua> for T where
    T: ToLua<'lua>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,