Ashita Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== Events ======

One of the main ways that Ashita allows addons to obtain various important data from the hook is through the method of events. Events are callback functions that are fired within an addons Lua state whenever the hook core handles something that warrants an addon to be notified. This can happen for things such as incoming or outgoing packets, chat commands entered by the user, etc.

The following events are currently valid within Ashita's core hook that are exposed to addons:
    * load
    * unload
    * command
    * newchat
    * incoming_packet
    * outgoing_packet
    * prerender
    * render
    * timer_pulse

----

==== Registering To Events ====

Addon developers can register to an event using one of two methods. The short-hand method, or the long-hand method. 

**Short-hand Method**
<code lua>
ashita.register_event('load', function()
    print('Load event fired!');
end);
</code>

**Long-hand Method**
<code lua>
function loadfunction()
    print('Load event fired!');
end

ashita.register_event('load', loadfunction);
</code>

----

=== load Event ====

afasf

Ashita Documentation

User Tools

Site Tools

Page Tools