====== Events Library ======

The events library extends the pre-existing events by adding even more that users can make use of in their addons.\\
To use events, check out [[addons:events|this guide]] on making use of them in your addon.

None of these events return a value.

----

==== Emote Event ====

Called when an emote occurs.

<code lua>
ashita.register_event('emote', function(emoteId, senderIndex, targetIndex, emoteFlag)
end);
</code>

----

==== Examined Event ====

Called when the player is examined.

<code lua>
ashita.register_event('examined', function(name, index)
end);
</code>

----

==== Exp Gain Event ====

Called when there is an exp event. 

<code lua>
ashita.register_event('exp_gain', function(exp, chain, meritmode)
end);
</code>

----

==== Gain Buff Event ====

Called when the player gains a buff.

<code lua>
ashita.register_event('gain_buff', function(id)
end);
</code>

----

==== HP Change Event ====

Called when the players health changes.

<code lua>
ashita.register_event('hp_change', function(old, new)
end);
</code>

----

==== HP Max Change Event ====

Called when the players max health changes.

<code lua>
ashita.register_event('hpmax_change', function(old, new)
end);
</code>

----

==== Job Change Event ====

Called when the players job changes.

<code lua>
ashita.register_event('job_change', function(mjob, mjoblvl, sjob, sjoblvl)
end);
</code>

----

==== Level Down Event ====

Called when the player levels down.

<code lua>
ashita.register_event('level_down', function(mjob, mjoblvl)
end);
</code>

----

==== Level Up Event ====

Called when the player levels up.

<code lua>
ashita.register_event('level_up', function(mjob, mjoblvl)
end);
</code>

----

==== Linkshell Change Event ====

Called when the player changes their linkshell.

<code lua>
ashita.register_event('linkshell_change', function(old, new)
end);
</code>

----

==== Login Event ====

Called when the player logs in.

<code lua>
ashita.register_event('login', function(name)
end);
</code>

----

==== Logout Event ====

Called when the player logs out.

<code lua>
ashita.register_event('logout', function(name)
end);
</code>

----

==== Lose Buff Event ====

Called when the player loses a buff.

<code lua>
ashita.register_event('lose_buff', function(id)
end);
</code>

----

==== MP Change Event ====

Called when the players mp changes.

<code lua>
ashita.register_event('mp_change', function(old, new)
end);
</code>

----

==== MP Max Change Event ====

Called when the players max mp changes.

<code lua>
ashita.register_event('mpmax_change', function(old, new)
end);
</code>

----

==== Party Invite Event ====

Called when the player receives a party invite. 

<code lua>
ashita.register_event('party_invite', function(name)
end);
</code>

----

==== Status Change Event ====

Called when the players status changes.

<code lua>
ashita.register_event('status_change', function(old, new)
end);
</code>

----

==== Target Change Event ====

Called when the players target changes.

<code lua>
ashita.register_event('target_change', function(index)
end);
</code>

----

==== TP Change Event ====

Called when the players TP changes.

<code lua>
ashita.register_event('tp_change', function(old, new)
end);
</code>

----

==== Weather Change Event ====

Called when the weather changes.

<code lua>
ashita.register_event('weather_change', function(weather)
end);
</code>

----

==== Zone Change Event ====

Called when the player changes zones.

<code lua>
ashita.register_event('zone_change', function(old, new)
end);
</code>