Enum sulis_state::script::script_callback::FuncKind

pub enum FuncKind {
    OnSwapWeapons,
    OnHeldChanged,
    OnEffectApplied,
    OnMenuSelect,
    OnRemoved,
    OnDamaged,
    BeforeAttack,
    AfterAttack,
    AfterDefense,
    BeforeDefense,
    OnAnimComplete,
    OnAnimUpdate,
    OnRoundElapsed,
    OnMoved,
    OnSurfaceRoundElapsed,
    OnMovedInSurface,
    OnEnteredSurface,
    OnExitedSurface,
    OnActivated,
    OnDeactivated,
}

A type of callback function for a CallbackData object.

Variants

OnSwapWeapons

Save compatibility only. TODO remove this after a while

OnHeldChanged

Called when an entity swaps their weapon set

OnEffectApplied

Called when a new effect is applied to a parent

OnMenuSelect

Called when a menu option is selected in a custom menu

OnRemoved

Called whenever an effect is removed from a parent

OnDamaged

Called whenver a parent entity loses hit points

BeforeAttack

Called on the attacking entity immediately before the attack is rolled Only applies to standard weapon attacks.

AfterAttack

Called on the attacking entity immediately after the attack is rolled. Only applies to standard weapon attacks.

AfterDefense

Called on the defending entity immediately after the attack is rolled. Only applies to standard weapon attacks.

BeforeDefense

Called on the defending entity immediately before the attack is rolled. Only applies to standard weapon attacks.

OnAnimComplete

Called whenever an animation copmletes, due to its duration elapsing or the owning effect being removed.

OnAnimUpdate

Called at a specific time elapsed on an animation update.

OnRoundElapsed

Called once each time a round elapses for the parent

OnMoved

Called each time an entity moves a square

OnSurfaceRoundElapsed

Only relevant for surfaces. Called once each time a round elapses for the surface effect, including a list of all affected entities as targets.

OnMovedInSurface

Called each time an entity moves within a given surface. Controlled by set_squares_to_fire_on_moved

OnEnteredSurface

Called when an entity enters a surface

OnExitedSurface

Called when an entity exits a surface

OnActivated

Called when an ability is activated

OnDeactivated

Called whena an ability mode is deactivated

Trait Implementations

impl Clone for FuncKind

fn clone(&self) -> FuncKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FuncKind

impl Debug for FuncKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FuncKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for FuncKind

impl Hash for FuncKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for FuncKind

fn cmp(&self, other: &FuncKind) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FuncKind> for FuncKind

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<FuncKind> for FuncKind

fn partial_cmp(&self, other: &FuncKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FuncKind

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

Serialize this value into the given Serde serializer.

impl StructuralEq for FuncKind

impl StructuralPartialEq for FuncKind