hooks

Plugin hooks for IITC. This file defines the infrastructure for managing and executing hooks, which are used to trigger custom plugin actions at specific points in the application lifecycle. Plugins may listen to any number of events by specifying the name of the event and providing a function to execute when an event occurs. Callbacks receive additional data created by the event as their first parameter. The value is always an Object that contains more details.

For example, this line will listen for portals to be added and print the data generated by the event to the console: window.addHook('portalAdded', function(data) { log.log(data) });

Boot hook: booting is handled differently because IITC may not yet be available. Have a look at the plugins in plugins/. All code before // PLUGIN START and after // PLUGIN END is required to successfully boot the plugin.

Description of available hook events:

  • portalSelected: Triggered when a portal on the map is selected or unselected. Provides the GUID of both the selected and unselected portal.
  • mapDataRefreshStart: Triggered at the start of refreshing map data.
  • mapDataEntityInject: Triggered just as we start to render data. Allows injecting cached entities into the map render.
  • mapDataRefreshEnd: Triggered when the map data load is complete.
  • portalAdded: Triggered when a portal has been received and is about to be added to its layer group. Does not guarantee the portal will be visible or shown soon. Portals added to hidden layers may never be shown. Injection point is in code/map_data.js#renderPortal near the end. Provides the Leaflet CircleMarker for the portal in the "portal" variable.
  • linkAdded: Triggered when a link is about to be added to the map.
  • fieldAdded: Triggered when a field is about to be added to the map.
  • portalRemoved: Triggered when a portal has been removed.
  • linkRemoved: Triggered when a link has been removed.
  • fieldRemoved: Triggered when a field has been removed.
  • portalDetailsUpdated: Fired after the details in the sidebar have been (re-)rendered. Provides data about the selected portal.
  • commDataAvailable: Runs after data for any of the chats has been received and processed, but not yet been displayed. The data hash contains both the unprocessed raw ajax response as well as the chat data that is going to be used for display.
  • publicChatDataAvailable: Similar to chatDataAvailable, but for all chat only.
  • factionChatDataAvailable: Similar to publicChatDataAvailable, but for faction chat.
  • alertsChatDataAvailable: Similar to publicChatDataAvailable, but for alerts chat.
  • requestFinished: Deprecated. Recommended to use mapDataRefreshEnd instead. Called after each map data request is finished. Argument is {success: boolean}.
  • iitcLoaded: Called after IITC and all plugins have loaded.
  • portalDetailLoaded: Called when a request to load full portal detail completes. Parameters are guid, success, details.
  • paneChanged: Called when the current pane has changed. On desktop, this changes the current chat pane; on mobile, it also switches between map, info, and other panes defined by plugins.
  • artifactsUpdated: Called when the set of artifacts (including targets) has changed. Parameters are old, new.
  • nicknameClicked: Event triggered when a player's nickname is clicked.
  • geoSearch: Event triggered during a geographic search.
  • search: Event triggered during a search operation.

Methods

inner addHook(event, callback)
code/hooks.js, line 93

Registers a callback function for a specified hook event.

Parameters:
Name Type Description
event string

The name of the hook event.
callback function

The callback function to be executed when the event is triggered.

inner removeHook(event, callback)
code/hooks.js, line 112

Removes a previously registered callback function for a specified hook event. Callback must the SAME function to be unregistered.

Parameters:
Name Type Description
event string

The name of the hook event.
callback function

The callback function to be removed.

inner runHooks(event, dataopt) → {boolean}
code/hooks.js, line 63

Executes all callbacks associated with a given hook event.

Parameters:
Name Type Attributes Description
event string

The name of the hook event.
data Object <optional>

Additional data to pass to each callback.
Returns:
boolean -

Returns false if the execution of the callbacks was interrupted, otherwise true.