UI Events in Firefall allow a UI designer or modder to trigger functions when certain things happen in the game.
For any given plugin, Firefall will only track events listed within the <events> </events> tags as such in the .XML file:
<Events> <Event name="ON_COMPONENT_LOAD" bind="OnComponentLoad" /> <Event name="ON_WEAPON_CHANGED" bind="OnWeaponChanged"/> <Event name="ON_WEAPON_STATE_CHANGED" bind="OnWeaponStateChanged"/> <Event name="ON_WEAPON_RELOAD" bind="OnWeaponReload" /> <Event name="MY_HUD_SHOW" bind="OnHudShow"/> </Events>
- name lists the event to be tracked.
- bind lists the name of the function (defined in Lua) to trigger when event in name occurs. Some events pass an object to the function as an argument, which serves to provide some info about the event.
function OnComponentLoad() -- do stuff end
As of April 7 2013, Lemon King has produced a list of UI events. Please use it when updating this page and other UI event documentation pages. Thanks. And refer to this one too, search the api directory for used events.