UI Events

From Firefall Wiki
Revision as of 00:04, 9 February 2014 by Depth (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.

Lua Example:

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.

Known Events

Event Description
UI Event Template A template page to use when creating entries for the below events
BKG_TOGGLE
DO_THUMPER_SCREEN_SHAKE
ENC_ATTACK_DEFEND_EVENT
ENC_DEATHMATCH_EVENT
ENC_HACK_EVENT
ENC_HARVESTER_EVENT
LOGIN_MESSAGE_HANDLER
MOD_CAPTUREPOINT_EVENT
MOD_GAUGEPAIR_EVENT
MOD_TIMER_EVENT
MY_ABILITY_DEPLOYABLE
MY_ACHIVEMENT_HANDLER
MY_ACTIVITY_TRACKER_CLEAR
MY_ACTIVITY_TRACKER_DELETE
MY_ACTIVITY_TRACKER_UPDATE
MY_ADD_CHARACTER
MY_ADD_CHAT_INPUT
MY_ARMY_TOGGLE
MY_BATTLEFRAME_TERMINAL
MY_BEGIN_CHAT
MY_CARRIER_CHANGED
MY_CFT_REWARD_DISPLAY
MY_CFT_REWARD_HIDE
MY_CHARACTER_CREATION_END
MY_CHARACTER_TOGGLE
MY_CHAT_MESSAGE
MY_CHAT_SCROLL
MY_CINEMATIC_EVENTS
MY_COLORPICKER_HANDLER
MY_CONNECT
MY_DASHBOARD
MY_DEMO_EVENT
MY_DUEL_HANDLER
MY_DURABILITY_EXPAND
MY_DURABILITY_FOSTER
MY_ENCOUNTER_ADDED
MY_ENCOUNTER_REMOVED
MY_ENCOUNTER_UPDATED
MY_ENCOUNTER_WAYPOINT_HIDE
MY_ENCOUNTER_WAYPOINT_SHOW
MY_ENDSCREEN_EVENT
MY_ERROR_FEEDBACK
MY_EXITGAME_HANDLER
MY_FINALE_EVENT
MY_FORGE_TOGGLE
MY_FOSTER_CHAT_TAB
MY_FOUNDERSPACK_PROMO
MY_FRIENDS_LIST_HANDLER
MY_FULLPANEL_EVENT
MY_HIDE_ENTITY_PLATE
MY_HIDE_HUD_REQUEST
MY_HIDE_WEBUI
MY_HUD_NOTE
MY_HUD_SHOW
MY_INFOPANE_MODULE
MY_INIT_OPTIONS
MY_INVENTORY_SHOW
MY_INVENTORY_TOGGLE
MY_LEADERBOARD_PVP
MY_LOADOUTS_TOGGLE
MY_LOBBY_TOGGLE
MY_LOGIN_FAILURE
MY_LOGOUT_HANDLER
MY_LOOT_COLLECTED
MY_MAILBOX_TOGGLE
MY_MARKER_ENTERED_SCREEN
MY_MARKER_EXITED_SCREEN
MY_MARKET_SEARCH
MY_MATCH_QUEUE_RESPONSE
MY_MATCHLIST_TOGGLE
MY_MATCHMAKER_MESSAGE_HANDLER
MY_MATCHMAKER_TOGGLE
MY_MENU_LOCK
MY_MISSION_ACTIVITY_TRACKER_DELETE
MY_MISSION_ACTIVITY_TRACKER_UPDATE
MY_MISSION_EVENT
MY_NAVWHEEL_TOGGLE
MY_NOTIFICATION_TOGGLE
MY_NOTIFY
MY_OPTIONS_DISPLAY
MY_OPTIONS_TOGGLE
MY_OUTPOST_STATUS_CHANGE
MY_PANEL_MANAGER
MY_PERSONAL_WAYPOINT_CHANGED
MY_PERSONAL_WAYPOINT_SET
MY_PLAYER_CHOSE_MARKER
MY_PLAYINTRO
MY_PRELOAD_EVENT
MY_QUEUE_SCREEN
MY_RADAR_ACTION
MY_RADAR_TOGGLE
MY_REFRESH_CHARACTERS_REQUEST
MY_RESOURCE_VEIN_ADDED
MY_RESOURCE_VEIN_REMOVED
MY_SHOW_MISSION_WAYPOINTS
MY_SHOW_WEBUI
MY_SLASH_HANDLER
MY_SPLASH_SCREEN
MY_SQUAD_HANDLER
MY_SUB_NOTIFY
MY_SUMMARY_UPDATE
MY_SYSTEM_MESSAGE
MY_TAB
MY_TAB_EVENT
MY_TEAM_UPDATE
MY_TECHSLOT_HINT
MY_TOGGLE_MENU
MY_TUTORIAL_MODE_TOGGLE
MY_TWEAKUI_HANDLER
MY_TWITCH_HUD
MY_USE_HUD_REQUEST
MY_VEHICLE_MODE_SHOW
MY_WAITNG_SCREEN
MY_WAYPOINT_EVENT
MY_WEBUI_TOGGLE
MY_WORKBENCHES_TOGGLE
MY_WORLD_MAP_SELECT
MY_WORLD_MAP_TOGGLE_REQUEST
ON_ABILITIES_CHANGED
ON_ABILITY_FAILED
ON_ABILITY_IN_EFFECT
ON_ABILITY_READY
ON_ABILITY_SELECTED
ON_ABILITY_STATE
ON_ABILITY_USED
ON_ACHIEVEMENT_COMPLETED
ON_ACHIEVEMENT_OBJECTIVE_UPDATE
ON_ACHIEVEMENT_PROGRESS_NOTICE
ON_ACHIEVEMENT_STATUS_UPDATE
ON_ACHIEVEMENT_TRACKED
ON_ACHIEVEMENTS
ON_ACHIVEMENTS
ON_ACTIVITY_TRACKER_DELETE
ON_ACTIVITY_TRACKER_UPDATE
ON_AFK_CHANGED
ON_ARMY_JOIN
ON_ARMY_LEAVE
ON_ARMY_ROSTER_TOGGLE
ON_ARMY_TOGGLE
ON_ARMYTAG_CHANGED
ON_AUTHENTICATE_SUCCESS
ON_AWAITING_RESPAWN
ON_BATTLEFRAME_CHANGED
ON_BATTLEFRAME_TERMINAL
ON_BEGIN_CHAT
ON_CACHE_INVENTORY_CHANGED
ON_CAMERA_CHANGE
ON_CAMERA_MOUSE_CHANGED
ON_CAMPAIGN_RANK_POINTS_CHANGED
ON_CANCEL_RESPAWN
ON_CANNOT_CONNECT_TO_AUTH
ON_CAPTURE_POINT_UPDATE
ON_CARRYABLE_OBJECT_INFO_CHANGED
ON_CARRYABLE_OBJECT_STATUS_CHANGED
ON_CARRYABLE_OBJECT_VITALS_CHANGED
ON_CHANNEL_JOIN
ON_CHANNEL_LEAVE
ON_CHARACTER_INFO_CHANGED
ON_CHARACTER_STATUS_CHANGED
ON_CHARACTER_TOGGLE
ON_CHARACTER_VITALS_CHANGED
ON_CHAT_MESSAGE
ON_CHAT_MESSAGE_RATE_LIMITED
ON_CHAT_MESSAGE_USER_NOT_AVAILABLE
ON_CHAT_SCROLL
ON_COMBAT_EVENT
ON_COMPONENT_GOT_FOCUS
ON_COMPONENT_LOAD
ON_COMPONENT_LOST_FOCUS
ON_COMPONENT_UNLOAD
ON_CONNECTION_PROBLEMS
ON_CONSOLE_ACCELERATE_BORED_GAUGE
ON_CONSOLE_ALTER_ACTIVITY_DIRECTOR_CONSTANTS
ON_CONSOLE_HIDE_ACTIVITY_DIRECTOR_DEBUG
ON_CONSOLE_REQUEST_ACTIVITY
ON_CONSOLE_SET_BORED_GAUGE
ON_CONSOLE_SHOW_ACTIVITY_DIRECTOR_DEBUG
ON_CONSUMABLE_AUTOSELECT
ON_CURSOR_ENTER_AREA_MARKER
ON_CURSOR_LEAVE_AREA_MARKER
ON_CUTSCENE
ON_DAILIES_COMPLETED
ON_DAILY_LOGIN_REWARD
ON_DAILY_STATUS_UPDATE
ON_DASHBOARD
ON_DEATH
ON_DEBUG_EVAL
ON_DEPLOYABLE_INFO_CHANGED
ON_DEPLOYABLE_ROSTER_UPDATE
ON_DEPLOYABLE_STATUS_CHANGED
ON_DEPLOYABLE_VITALS_CHANGED
ON_DEV_LIST_ZONES
ON_DISTRIBUTIONLIST_CHANGED
ON_DOWNED
ON_DRAGDROP_BEGIN
ON_DRAGDROP_CANCELLED
ON_DRAGDROP_END
ON_DUEL_UPDATED
ON_EFFECTS_CHANGED
ON_ENCOUNTER_INFO
ON_ENCOUNTER_PROXY_ADDED
ON_ENCOUNTER_PROXY_REMOVED
ON_ENCOUNTER_PROXY_UPDATED
ON_ENCOUNTER_REWARD
ON_ENCOUNTER_UI_EVENT
ON_ENCOUNTER_UI_SCOPED_IN
ON_ENCOUNTER_UI_SCOPED_OUT
ON_ENCOUNTER_UI_UPDATED
ON_ENCOUNTER_UPDATE
ON_ENCOUNTER_WAYPOINT_HIDE
ON_ENCOUNTER_WAYPOINT_SHOW
ON_ENCOUNTER_WAYPOINT_UPDATE
ON_ENERGY_CHANGED
ON_ENTER_AREA_MARKER
ON_ENTER_ENCOUNTER_PROXY
ON_ENTER_OUTPOST_REGION
ON_ENTER_TRIGGER_VOLUME
ON_ENTER_TURRET
ON_ENTER_VEHICLE
ON_ENTER_ZONE
ON_EXIT_GAME
ON_EXIT_TURRET
ON_EXIT_VEHICLE
ON_EXIT_ZONE
ON_EXPERIENCE_CHANGED
ON_EXPERIENCE_TABLE_CHANGED
ON_FIRSTLOGIN
ON_FLASHLIGHT_TOGGLED
ON_FORGE_TOGGLE
ON_FRIEND_REQUEST_DECLINED
ON_FRIEND_REQUEST_ERROR
ON_FRIEND_REQUEST_RECEIVED
ON_FRIEND_STATUS_CHANGED
ON_FRIENDLY_DISTRESS
ON_FRIENDS_LIST_TOGGLE
ON_GAME_SCENE_OBJECT_OP
ON_GAME_VARIABLE_ADDED
ON_GAME_VARIABLE_REMOVED
ON_GAME_VARIABLE_UPDATED
ON_GAMEPLAY_PAUSED
ON_GAMEPLAY_TOOLTIP
ON_GHOST
ON_GLOBE_ROTATED_TO_ZONE
ON_HARDPOINT_OPTIONS
ON_HEALTH_CHANGED
ON_HEATMAP_UPDATED
ON_HIDE_MAPMARKER_WAYPOINT
ON_HIT_TARGET_CONFIRM
ON_HIT_TARGET_PREDICT
ON_HOTKEY_PRESSED
ON_INCAPACITATE
ON_INPUT_MODE_CHANGED
ON_INTERACT_ATTEMPT
ON_INTERACT_AVAILABLE
ON_INTERACT_END
ON_INTERACT_INVALIDATED
ON_INTERACT_PROGRESS
ON_INTERACT_SHOW_MENU
ON_INTERACT_UNAVAILABLE
ON_INVENTORY_CHANGED
ON_INVENTORY_ENTRY_CHANGED
ON_INVENTORY_TOGGLE
ON_INVENTORY_WEIGHT_CHANGED
ON_KEYBINDINGS_CHANGE
ON_KILL_MESSAGE
ON_LEADERBOARD_PVP
ON_LEAVE_AREA_MARKER
ON_LEAVE_ENCOUNTER_PROXY
ON_LEAVE_OUTPOST_REGION
ON_LEAVE_TRIGGER_VOLUME
ON_LEVEL_CHANGED
ON_LOADOUTS_CHANGED
ON_LOADOUTS_TOGGLE
ON_LOBBY_CREATE_RESPONSE
ON_LOBBY_INVITE_RECEIVED
ON_LOBBY_INVITE_RESPONSE
ON_LOBBY_JOINED
ON_LOBBY_KICKED
ON_LOBBY_LEAVE
ON_LOBBY_MATCH_PARAMETERS_UPDATE
ON_LOBBY_MATCH_STARTING
ON_LOBBY_READY_CHECK
ON_LOBBY_ROSTER_UPDATE
ON_LOCALIZED_TIP_MESSAGE
ON_LOCK_WARNING
ON_LOGIN
ON_LOGIN_FAILURE
ON_LOGIN_RESPONSE
ON_LOOT_COLLECTED
ON_LOOT_PICKUP
ON_MAILBOX_TOGGLE
ON_MAP_MARKER_ADD
ON_MAP_MARKER_REMOVE
ON_MAP_MARKER_UPDATE
ON_MAP_PING
ON_MARKET_LISTING_COMPLETE
ON_MATCH_COMPLETED_XP
ON_MATCH_FORCE_UNQUEUE
ON_MATCH_QUEUE_RESPONSE
ON_MATCH_QUEUE_UPDATE
ON_MATCHLIST_TOGGLE
ON_MISS_TARGET
ON_MISSION_LEDGER
ON_MISSION_LOG_TOGGLE
ON_MISSION_OBJECTIVE_UPDATE
ON_MISSION_STATUS_UPDATE
ON_MISSION_TRACKED
ON_MOVEMENT_MODIFIER
ON_NAVWHEEL_TOGGLE
ON_NETWORK_STATE_CHANGED
ON_NEW_DAILIES
ON_NEW_SERVER_QUERY
ON_NOTIFICATION_TOGGLE
ON_NOTIFY
ON_NPC_BEHAVIOR_CHANGED
ON_NPC_DIALOG_UPDATE
ON_OBJECTIVE_WAYPOINT_UPDATE
ON_OPERATOR_DIALED_IN
ON_OPPONENT_CRIT
ON_ORACLE_ERROR
ON_PLACE_CALLDOWN
ON_PLAY_MOVIE
ON_PLAYER_CRIT
ON_PLAYER_CROUCH
ON_PLAYER_GLIDE
ON_PLAYER_JOINED_CHAT_CHANNEL
ON_PLAYER_LEFT_CHAT_CHANNEL
ON_PLAYER_LEFT_OVERLAY
ON_PLAYER_OVER_OVERLAY
ON_PLAYER_READY
ON_PLAYER_SPRINT
ON_PLAYER_TOGGLE_OVERLAY
ON_PRE_RELOADUI
ON_PVP_CANCEL_QUEUE
ON_PVP_QUEUE_FAILURE
ON_PVP_TOGGLE
ON_QUICK_CHAT_RECEIVE
ON_QUICK_CHAT_UPDATE
ON_RADAR_TOGGLE
ON_RADAR_ZOOM
ON_RADIO_UPDATE
ON_RECIPE_LIST_UPDATE
ON_REDBEAN_STORE
ON_REPLAY_SETTIME
ON_REPLAY_TIME_SCALED
ON_RESET_TRIGGER_VOLUME
ON_RESOLUTION_CHANGED
ON_RESOURCE_DETECT_HEAT
ON_RESOURCE_DETECT_MODE
ON_RESOURCE_NODE_YIELD
ON_RESOURCE_SCAN_EXPIRED
ON_RESOURCE_SCAN_FAILED
ON_RESOURCE_SCAN_REPORT
ON_RESOURCE_SCAN_UPDATED
ON_RESOURCENODE_INFO_CHANGED
ON_RESOURCENODE_STATUS_CHANGED
ON_RESOURCENODE_VITALS_CHANGED
ON_RESOURCES_CHANGED
ON_RETICLE_STATUS_CHANGED
ON_REVIVE
ON_REVIVE_END
ON_REVIVE_PROGRESS
ON_REWARD_INFO
ON_SALVAGE_RESPONSE
ON_SCORE_CHANGED
ON_SCOREBOARD_CHANGED
ON_SCREENSHOT
ON_SCROLL_CALLDOWN
ON_SEAT_CHANGED
ON_SEND_POI_MESSAGE
ON_SERVER_QUERY_CANCELLED
ON_SESSION_LEVEL_CHANGED
ON_SESSION_XP_CHANGED
ON_SET_GAME_TYPE
ON_SHOPPING_LIST_UPDATED
ON_SIN_CARD_OP
ON_SIN_CONTROL_CHANGED
ON_SIN_OBJECT_MOUSEOVER
ON_SIN_UPLINK_REVEALED
ON_SIN_VIEW
ON_SINSTATUS_CHANGED
ON_SINVIRONMENT_STREAM_PROGRESS
ON_SINVIRONMENT_TOGGLED
ON_SPAWN
ON_SPECTATE_PLAYER
ON_SPECTATED_SIMULATED_HIT
ON_SPECTATING_HEALTH_UPDATE
ON_SPECTATOR_MODE
ON_SQUAD_INVITE_DECLINED
ON_SQUAD_INVITE_FORWARD_RECEIVED
ON_SQUAD_INVITE_RECEIVED
ON_SQUAD_INVITE_REQUEST_RECEIVED
ON_SQUAD_JOIN
ON_SQUAD_LEAVE
ON_SQUAD_ROSTER_UPDATE
ON_SQUAD_VITALS_UPDATE
ON_SQUAD_WAYPOINT_UPDATE
ON_START_THUMPER_ENCOUNTER
ON_STOP_THUMPER_ENCOUNTER
ON_STREAM_PROGRESS
ON_SUBMIT_CRASH_DUMP_COMPLETED
ON_SUPERCHARGE_CHANGED
ON_SUPPORT_SCREENSHOT
ON_TAB_TOGGLE
ON_TEAM_CHANGED
ON_TEAM_UPDATE
ON_TERMINAL_AUTHORIZED
ON_TOGGLE_MENU
ON_TOGGLE_MOUSE_MODE
ON_TOGGLE_PLAYER_CARD
ON_TOKEN_VENDOR_RESPONSE
ON_TOOK_HIT
ON_TRANSLATE
ON_TWITCH_AUTH
ON_TWITCH_STATUS
ON_UI_ACTION_REQUEST
ON_UI_ENTITY_AVAILABLE
ON_UI_ENTITY_FOCUS
ON_UI_ENTITY_LOST
ON_UI_FIRST_START
ON_UNIT_TEST
ON_UNLOCK_CONTENT
ON_URL_ACCESS
ON_USER_SCREENSHOT
ON_VEHICLE_COLLIDED
ON_VEHICLE_HEALTH_CHANGE
ON_VEHICLE_INFO_CHANGED
ON_VEHICLE_STATUS_CHANGED
ON_VEHICLE_TOOK_HIT
ON_VEHICLE_UPDATE
ON_VEHICLE_VITALS_CHANGED
ON_VENDING_MACHINE_WINNER
ON_VENDOR_BEGIN
ON_VENDOR_END
ON_VERTICAL_SLICE
ON_VIP_STATUS_CHANGED
ON_VOIP_PLAYER_STATUS_CHANGED
ON_VOIP_SQUAD_PUSH_TO_TALK
ON_VOTEKICK_INITIATED
ON_VOTEKICK_RESPONDED
ON_WALLET_CHANGED
ON_WAYPOINT_UPDATE
ON_WEAPON_BURST
ON_WEAPON_CHANGED
ON_WEAPON_CHARGEUP_CHANGED
ON_WEAPON_FAIL
ON_WEAPON_MODE_CHANGED
ON_WEAPON_RELOAD
ON_WEAPON_STATE_CHANGED
ON_WEB_MESSAGE_RECEIVED
ON_WEBUI_TOGGLE
ON_WHEEL_BACK
ON_WHEEL_EXIT
ON_WHEEL_MIDDLE
ON_WHEEL_SCROLL
ON_WHEEL_SUBMIT
ON_WORKBENCH_TOGGLE
ON_WORLD_MAP_SET
ON_WORLD_MAP_TOGGLED
ON_WORLD_OBJECT_REMOVED
ON_WORLD_OBJECT_UPDATED
ON_WRENCHES_CHANGED
ON_XP_BOOST_MODIFIER_CHANGED
ON_ZONE_QUEUE_UPDATE
SCORE_SUMMARY_EVENT
WEB_CRAFTING_UPDATE
ZONESEL_EVENT_HANDLER