DSB/Events and System Functions

System Functions

When certain things happen globally, or values are needed, the game engine will call sys_ functions.

sys_render_other(gui_name)

Add a new table to gui_info, like this:

  gui_info.my_new_graphic = {
     x = 20,
     y = 100,
     w = 200,
     h = 96
  }

When sys_render_other is called, the gui_name parameter will be a string containing "my_new_graphic" or whatever you called the table.

All of them are contained in base/system.lua (except for the rendering-related ones, in base/render.lua), so look there for now. If anyone wants to wiki-ize the list, feel free. I'll be working mostly on things that I haven't documented somewhere else. -- Sophia

Events

When certain things happen to a specific object, the game engine (or, sometimes, the Base Code) will call various events associated with an object arch.

on_throw(self, id, location)

The location is where the object is thrown "from," via an attack method. It is nil if the object is thrown from the mouse hand. In that case, if you need to assume the throw came from some inventory zone, you can use the global variable mouse_throwing_hand.

See also base/methods.lua: method_throw_obj.

on_impact(self, id, hit_what, hit_ppos)

This function is called when an inst hits something. If it hits a monster or object, hit_what will be set to an inst id. If it hits a party member, hit_what will be nil, hit_ppos will be the party position that it hit.

See also base/damage.lua: explode_thing, poisonbomb_thing, etc.

on_deplete(self, id)

When an inst with charges consumes its last charge, this event is called. If this event doesn't exist, but the arch has a convert_deplete property, a dsb_swap is executed. Otherwise, the object is deleted.

on_click(self, id, clicked_with, cx, cy)

Used on a mirror, or a compass. The cx and cy values are the exact coordinates (relative to the upper left corner of the object's bitmap) that you clicked on, making it possible to define custom "click zones" with a bit of hacking.

on_look(self, id, whose_eye) = new_id

This is called when you click on someone's eye with an inst. If it returns an id, that id is shown, instead of the one actually held to the eye.

on_drop(self, id)

Called when an inst is dropped. If it returns true, the inst can't be dropped.

on_zone_drop(self, drop_zone_id, dropped_obj_id)

Called when an inst is dropped into a drop zone (i.e., an alcove). If it returns true, the alcove won't accept the inst.

on_trigger(self, id, trigger_id)

Called when something is put on a flooritem. (If trigger_id is nil, it's the party)

off_trigger(self, id, trigger_id)

Called when something comes off a flooritem. (If trigger_id is nil, it's the party)

on_turn(self, id, dir)

Useful for the compass, for example.

on_fly(id, x, y, tile, face, flytimer)

Used in the test_dungeon, see crazy axe.

on_consume

See function eatdrink, where you need to set a foodval or waterval property for the arch type.

on_spawn

Fired when created, such as a monster death cloud of dust.

on_melee_damage_monster

An event for hooking attack methods of specific weapons

on_monster_move_into

Event for objects that handle monster movement in special ways.

on_teleport

Called when teleporting the object.

on_incoming_impact(arch, inst, flying_inst)

Take a look at monster_dodge in base/monster.lua for the code that makes monsters hurriedly rearrange themselves on the tile if a projectile is about to hit them and there's somewhere to go.

Also for the inventory there are events such as to_feet(id, who), from_feet(id, who), to_neck(id, who), from_neck(id, who), to_r_hand, from_r_hand, to_l_hand, from_l_hand and I just found after_from_r_hand and after_from_l_hand which pleases me greatly... Where I've finally found a to_anywhere and from_anywhere event.

Not an 'event' as such but we also have flying_away, flying_toward, flying_side properties to assign if necessary for a bitmap.

potion_effect(id, who, base_power)

Create your own potions and effects.

hit_sound

Used for weapons, assigning a sound.

namechanger(id, who_look)

Used with the bones object or a Ven Bomb for example.

subrenderer(id)

Yeah, this is a good one... See the objects.lua

objzone_check(id, putting_in, zone)

See the objects.lua

Things such as stairs are objects of course and have events such as on_trigger, off_trigger, on_turn, on_try_move, ...