Struct sulis_state::script::script_callback::CallbackData

pub struct CallbackData { /* fields omitted */ }

A callback that can be passed to various functions to be executed later. A single callback can hold multiple invocations by setting several different functions.

add_target(target: ScriptEntity)

Adds the specified target to the list of targets this callback will provide to its callee.

add_targets(targets: ScriptEntitySet)

Adds the specified targets to the list of targets this callback will provide to its callee

add_selected_point(point: Table)

Adds the specified point to the list of points this callback will provide in its targets. The point is a table of the form {x:x_coord, y: y_coord}

add_affected_points(points: Table)

Adds the list of affected points to the affected_points this callback will provide its targets. The points is a list of tables of the form {x: x_coord, y: y_coord}

set_on_held_changed(func: String)

set_on_effect_applied_fn(func: String)

set_on_menu_select_fn(func: String)

set_on_removed_fn(func: String)

set_on_damaged_fn(func: String)

set_before_attack_fn(func: String)

set_after_attack_fn(func: String)

set_before_defense_fn(func: String)

set_after_defense_fn(func: String)

set_on_anim_update_fn(func: String)

set_on_anim_complete_fn(func: String)

set_on_round_elapsed_fn(func: String)

set_on_moved_fn(func: String)

set_on_surface_round_elapsed_fn(func: String)

set_on_moved_in_surface_fn(func: String)

set_on_entered_surface_fn(func: String)

set_on_exited_surface_fn(func: String)

Each of these methods causes a specified lua func to be called when the condition is met, as described in FuncKind. Multiple of these methods may be added to one Callback.

Implementations

impl CallbackData

pub fn clear_funcs_except(&mut self, keep: &[FuncKind])

pub fn kind(&self) -> Kind

pub fn parent(&self) -> usize

pub fn get_func(&self, func: FuncKind) -> Option<String>

pub fn update_entity_refs_on_load(
    &mut self,
    entities: &HashMap<usize, Rc<RefCell<EntityState>>>
) -> Result<(), Error>

pub fn update_effect_index_on_load(&mut self, index: usize)

pub fn new_ability(parent: usize, ability_id: &str) -> CallbackData

pub fn new_item(parent: usize, item_id: String) -> CallbackData

pub fn new_entity(parent: usize) -> CallbackData

pub fn new_trigger(parent: usize, script: String) -> CallbackData

pub fn add_func(&mut self, kind: FuncKind, name: String)

Trait Implementations

impl Clone for CallbackData

fn clone(&self) -> CallbackData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallbackData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallbackData

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

Deserialize this value from the given Serde deserializer.

impl ScriptCallback for CallbackData

fn on_held_changed(&self)

fn on_effect_applied(&self, effect: ScriptAppliedEffect)

fn on_menu_select(&self, value: ScriptMenuSelection)

fn on_removed(&self)

fn before_defense(&self, targets: &ScriptEntitySet)

fn before_attack(&self, targets: &ScriptEntitySet)

fn on_anim_complete(&self)

fn on_anim_update(&self)

fn on_round_elapsed(&self)

fn on_moved(&self)

fn on_surface_round_elapsed(&self)

when called, this computes the current target set and sends it to the lua function based on the surface state

fn on_moved_in_surface(&self, target: usize)

fn on_entered_surface(&self, target: usize)

fn on_exited_surface(&self, target: usize)

fn after_defense(
    &self,
    targets: &ScriptEntitySet,
    hit_kind: HitKind,
    damage: Vec<(DamageKind, u32)>
)

fn after_attack(
    &self,
    targets: &ScriptEntitySet,
    hit_kind: HitKind,
    damage: Vec<(DamageKind, u32)>
)

fn on_damaged(
    &self,
    targets: &ScriptEntitySet,
    hit_kind: HitKind,
    damage: Vec<(DamageKind, u32)>
)

impl Serialize for CallbackData

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

Serialize this value into the given Serde serializer.

impl UserData for CallbackData

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

Adds custom methods and operators specific to this userdata.